This is currently undergoing a complete rewrite, please see this repository
Dlool is the digital version of a homework book.
Classical homework books have many problems. A lot of people who use tablets in school do not have notebooks but a homework book is still needed. Here are some problems they have and how Dlool solves them:
Problem | Solution |
---|---|
Everyone in a class writes down the same | Dlool is collaborative, all entries from one class are available in one class. |
They are not very good for the environment | Dlool is digital, no paper is needed. |
They are not very practical | Dlool is available on all devices. |
Entries are not very structured | Dlool has a structured entry system. |
When you lose your homework book | Dlool is digital, you can't lose it. |
Every year you need a new homework book | Dlool can be used for multiple years. |
-
Clone this repository
git clone [email protected]:Dlurak/dloolBackend.git
-
Install the dependencies
npm install
-
Create a
.env
file in the root directory of the projecttouch .env
-
Add the following variables to the
.env
fileMongo_URI
=String to the Cluster<username>
,<password>
and<dbname>
can be replaced automatically, e.g.mongodb+srv:https://<username>:<password>@<dbname>.ljdmejo.mongodb.net/?retryWrites=true&w=majority
MONGO_PASSWORD
=Password for the databaseMONGO_USERNAME
=Username for the databaseMONGO_DBNAME
=Name of the databaseJWT_SECRET
=Secret for the JWT, just a random string
If you want to run tests, the test database needs to be droppable, so you need to add a new user on MongoDB with permission to drop the database. On Atlas it is the highest permission level. You will need to add the following variables to the
.env
file:MONGO_USERNAME_TEST
=Username for the newly created userMONGO_PASSWORD_TEST
=Password for the new user
- Compile the TypeScript code
npm run build
- Start the server
npm run start
- The server is now running on localhost port 3000
- Compile the TypeScript code
npm run build
- Create the static documentation HTML files
npm run document
- Start the documentation server
npm run serve:docs
- The server is now running on localhost port 3001
I want to thank the contributors of that repo.