One Paragraph of project description goes here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
-
You need to have java installed on your system. You can get the Java from here.
-
You also need to have MongoDB installed. Just download it as normal from here or if you like using docker like me, pull mongodb from here then run:
docker run -d -p 27017:27017 -v ~/data:/data/db mongo
-
And sure you need an IDE. For me, the best one is intellij IDEA.
A step by step series of examples that tell you how to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Add additional notes about how to deploy this on a live system
- Ktor - The backend framework used
- Gradle - Dependency Management
- MongoDB - Document-oriented database
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. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc