⏲ Productivity platform (no name, please suggest one at this issue)
This project is aimed towards those who want to be more productive, be more focused or want help managing their time.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
A step by step series of examples that tell you how to get a development env running.
-
Navigate into the project folder.
-
Install dependencies with
npm install
-
Navigate in each of the subprojects (backend/webclient) and run
npm install
again. -
In the backend folder, make a
.env
file with 2 keys:MONGODB_URI
andJWT_SECRET
, and then give them a database url and a jwt secret. -
Go to the project folder again.
-
Run
npm start
to start the backend and the webclient. -
You're ready to code.
Coming soon
Coming soon
Coming soon
Coming soon
Coming soon
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. When you submit a pull request, increment the appropriate part of the version in the package.json
file.
For example in version 1.3.4, the first number is the major release, second the minor release (minor features and stuff), and the third is for small stuff and bugfixes.
For every part of the version you increase, the parts after that, will be 0, for example 1.3.4 => 1.4.0, not 1.4.4
- Panagiotis Skarlas - Initial work - Github
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- PurpleBooth for this README template
- (More coming soon)