learn fullstack! (MERN Stack)
create a plex-like book library, with multiple books and user authentication, with the addition of having anki cards and even more to come...
If you have spare time, you can always make an addition to the system! If you have something different in mind than the listed additions below, just DM @kwlski on DC.
- implement one of the possible additions below, if you are a beginner I can help you getting your changes to github
- push your feature to a non protected branch, hereby we name the branch after the task it fulfills, in small letters. For example I make a documentation file for routes, so we are going to name the branch "routesdoc"
- open a pullrequest on github, that can be reviewed and merged into the "master" branch
- done! You have contributed!
to contribute, you will need to have an idea what the app should look like, for this please see the prototype:
- [in work, see the prototype of the project! Issue #2]
https://git-scm.com/downloads
https://nodejs.org/en/
now you can use git to clone this repository and get it so you have it locally on your machine as physical files for this go to your desired directory where you want to have your files and run the following command
git clone https://github.com/threedevs/3dev-fullstack.git
you should now see a folder 3dev-fullstack
open the folder 3dev-fullstack and install the packages that we need with following command from the npm registry
npm i
now you should be able to run the node server with nodemon which keeps track of changes and restarts the server if needed
nodemon server
now we can try using our server, for this open the frontend folder and run index.html in any way
- install mongodb on your system
- install mongo compass on your system
- connect with mongodb compass to your local mongodb server, you might need to start it first!
- add database with name "library" to your local mongodb server
- add collection with name "books" to your "library" database
- add collection with name "users" to your "library" database
https://www.figma.com/file/XIUfEV7DlJHJCxwN8BAz5U/Library?node-id=1%3A3
- for this, please see routes.md in the documentation folder
...
...
- to generate API docs we use APIDocs:
./node_modules/.bin/apidoc -i routers -o out/.
- note: if you chose to name the output directory other than "out" please include this in the ".gitignore" file