Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.92 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.92 KB

Prello 📋

Build Status

Online App website: https://prello22app.igpolytech.fr

Online API website: https://prello22api.igpolytech.fr

Online dashboard website: https://prello22dashboard.igpolytech.fr/

Project managing tool using MERN stack (Mongo - Express - React - NodeJS). Application developed during our 5th year of CS & Management formation at Polytech Montpellier.

Getting Started

Requirements

  • A MongoDB
  • npm for package dependencies management

Launch 🚀

  • Dependancies installation: npm install in both /client and /server folders.
  • Set your environment variables accordingly to the .env.example & .model.env files.
  • In localhost, you can use npm start for the client and npm run watch for the server.

Deployment

The client and server contain a Dockerfile. These Dockerfile are used by the /scripts/deploy.sh script to deploy the application to Dokku or Herokku for example. To use it, when you are at the root of the repository:

cd ./scripts

sh ./deploy.sh

Tests

You can run the tests in /client and /server folder by using the following command:

npm test

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details