keepr is an online inventory management web application. Registered users can add inventory workspaces -- providing an organized setup of multiple inventory groups. It can be accessed here -- keepr.
NOTE: If you downloaded the ZIP file of this project you can skip step 1.
- Clone the repository.
git clone https://github.com/Pierre120/keepr.git
Go to the keepr project folder.
cd keepr
- Install dependencies.
npm install
- Running project.
NOTE: If you're using your local MongoDB server then be sure that your server is up and running.
npm run dev
All the features of this project can be found in our MP - Phase 0 document.
Compilation is needed whenever there are saved changes with the SASS (.scss) files.
npm run compile:sass
This command behaves like the npm run dev command.
Every changes made to the SASS files it will automatically compile it to CSS.
Starting up the local MongoDB server is needed since the application needs to connect to a MongoDB server.
Run this command in a separate command prompt, terminal or any terminal-like program.
mongod
- Add a
.envfile in the root path (.) of the project folder. The same directory level as the.env.examplefile. - Copy the contents of
.env.examplefile to.envfile. - Set the
PORTvalue to5000.
PORT=5000
SESSION_SECRET=
MONGODB_URL=""
- Set the
MONGODB_URLto"mongodb://localhost/<db-name>".
PS: I used this -->MONGODB_URL="mongodb://localhost/keepr_db"
PORT=5000
SESSION_SECRET=
MONGODB_URL="mongodb://localhost/<db-name>"
- Tab: 2 spaces
- Create a branch for a specific feature
- For all or most feature branch, be sure to create a local test branch for each models. You're going to place the additional lines of code for testing in its test branch.
- Don't create a pull request unless the feature is done
- Be sure to recompile the SASS files when there are modifications
Ctrl + Cfor terminating the run commands