-
Notifications
You must be signed in to change notification settings - Fork 0
Tech
- MongoDB
- Firebase
- React
- Node JS
- Stripe JS
- Express
- TailwindCSS
We need to install a few programs before we can get started. Here are the links to all the programs required:
- Node JS - click yes if it asks you to install
- MongoDB Compass - Optional if you aren't working on the back-end
- Git
- GitHub Desktop - recommended but not required
- VS Code - recommended IDE
We will use Vite, a toolchain to help developers develop in React. It basically is a command line tool that will automatically install all dependencies (libraries and other code required) to run our project locally on our computer. It can be used to set up a new project (no need, as this one is already set up) and run projects with live updates so you can see what is happening locally on your computer. Open a terminal of your choice (I will write Windows command prompt commands as that is what I am using but it should work similarly on mac or Linux, just check online for the syntax). Open CMD/Terminal and navigate to the file directory for the project within the {INSERT FOLDER NAME}. Now run npm install, this only needs to be run once per project or every time a new package is added. This command will automatically install all the required packages.
Every time you begin coding, use your terminal, and navigate to the folder, and type npm run dev and then click the link. It should look something like http://localhost:0000/ (numbers will differ depending on your computer).
Here, you should be able to see your code update the live webpage. If you inspect the webpage, you will be able to see if there are any error codes. These will only update if you refresh the page.
You will have to do this for both API and Web folders. These will open on different ports, and you will need to run both for backend and frontend to work
For our project, we have our deployment set up in three environments. The first one is developer, this is the main one you will be using, this is what happens when you run npm run dev and it's hosted locally. The second one is a production developer environment, this is hosted on a server and you can access it with a website link {insert link}. This is able to be seen by everyone but it is not the production release, this gets updated every time main branch is updated. The third environment is production, this will be updated manually at every milestone and it is open to everyone. You don't need to worry about the details for this, if you need further clarification, please contact the tech lead. In summary, you just need to worry about your own local development environment.