Get started

Welcome to Fast Forward Dev

This will give you a quick rundown of the full stack project. Follow these steps to get started.

For a more detailed instllation guide go to this page.

The project is built with Next.js app router. If you have any questions feel free to contact Emil

The project is seperated into a frontend and a backend so you will need to clone two projects.

Frontend

1. In your terminal run the following commands. Remember to replace relevant parts.

terminal
1git clone git@github.com:EmilLykke/fast-forward-dev-client-basic.git name-of-own-folder
2cd name-of-own-folder
3git remote remove origin
4git remote add origin git@github.com:YOU/YOUR_NEW_REPO.git
5git push origin master
6git branch --set-upstream-to=origin/master master

2. Rename the .env.local.example file to .env.local and fill in the variables.

terminal
1mv .env.local.example .env.local

3. Install and run the project. When running the project the website will be avilable at http://localhost:3000

terminal
1npm install
2npm run dev

The project structure is as follows:

  • /app → Pages where 1 folder + page.tsx = 1 page
  • /app/api → API endpoints where 1 folder + ruoter.ts = 1 api endpoint
  • /components → Reusable components
  • /utils → For now the Stripe helper
  • /assets → Assets
  • /config → Includes the config files

/config/config.ts

This file includes some important variables for the project to function properly. Make sure to check it out and change the variables to your own.

Backend

1. In your terminal run the following commands. Remember to replace relevant parts.

terminal
1git clone git@github.com:EmilLykke/fast-forward-dev-server-basic.git name-of-own-folder
2cd name-of-own-folder
3git remote remove origin
4git remote add origin git@github.com:YOU/YOUR_NEW_REPO.git
5git push origin master
6git branch --set-upstream-to=origin/master master

2. Rename the .env.example file to .env and fill in the variables.

terminal
1mv .env.example .env

3. Install and run the project. When running the project the server will be avilable at http://localhost:5001

terminal
1npm install
2npm run dev

The project structure is as follows:

  • index.ts → The entry point of the server
  • /routes → Files for the different API endpoint routes
  • /models → Mongoose models for the database
  • /types → The typescript types
  • /google → Verify google token
  • /mailersend → Logic for sending emails
  • /mailersend/mail_templates → The different email templates