/compUp

backend code for a web site to sell computer parts

Primary LanguageJavaScript

inventory-management

For this project to work mongoDB, node and npm have to be installed on the system.

Stack Used:

Backend:      Node.js
Database:     MongoDB
Node version: 17.3.1 
NPM version:  8.3.0 
NPX version:  8.3.0

Steps:

  1. Install NPM and Node in accordance with the versions given above.
  2. Set up the .env files in both /server and /client using sample.env in each as a reference.
  3. Give the file "runProject.sh" and "buildProject.sh execution permission:
    chmod +x runProject.sh
    chmod +x buildProject.sh
  1. Build the project and install dependencies:
    npm run build
  1. Run it using any of the following commands:
    a. npm run start
    b. npm run server
    c. ./runProject.sh
  1. To start the client application use the following command:
    a. npm run client

The react client will be available at http://localhost:3000 and the Node.js + Express server will be available at http://localhost:{{PORT_SETUP_IN_.ENV}}.

Backend

I used Node.js because it has faster development time, requires less setup, and has ample community support. The express framework made it easy to create API endpoints quickly with minimal code. The code structure used will help maintain code readability as it scales later on in the project.