Get Started

Welcome to DevRocket 🚀! This boilerplate helps you build and launch your SaaS product in record time using Angular for the frontend and NestJS for the backend. Follow this quick start guide to set up your app and start building your dream project FAST ⚡️.

Once you're done with setup, check out the 5-minute tutorial to get your startup live.

You're browsing the /frontend and /backend setup documentation. If you're looking for other specific setups, refer to their individual sections.

Start a Local Server

1. Clone the repository and install dependencies

Open your terminal and run the following commands one by one:

git clone https://github.com/zmudson/DevRocket.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
 
# Install dependencies for both frontend (Angular) and backend (NestJS)
cd frontend
npm install
cd ../backend
npm install

Note: This project requires Node.js 18.17 or greater. You can check your Node.js version by running:

node -v

2. Configure environment variables

In both the frontend and backend folders, you will need to configure environment variables.

For NestJS (backend), create a .env.local file by copying the .env.example:

cd backend
mv .env.example .env.local

For Angular (frontend), set up any necessary environment variables by adjusting the .env or src/environments/environment.ts file.

3. Run the application

To start the backend (NestJS) server, run:

cd backend
npm run start:dev

To start the frontend (Angular) server, run:

cd frontend
ng serve

Now, open your browser and navigate to http://localhost:4200 for the frontend and http://localhost:3000 for the backend (if needed). Your app should now be running!

You might see console errors during development. Don’t worry—they’re not critical.