Code Monkey home page Code Monkey logo

3dev-fullstack's Introduction

3dev-fullstack

learn fullstack! (MERN Stack)

goal of this repository (vision)

create a plex-like book library, with multiple books and user authentication, with the addition of having anki cards and even more to come... layout

contribute

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.

how to

  • 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!

prototype

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]

how to use the repository

1. first you will need to install git and node

https://git-scm.com/downloads
https://nodejs.org/en/

2. clone the repository

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

3. install the dependencies

open the folder 3dev-fullstack and install the packages that we need with following command from the npm registry

npm i

4. run the server

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

5. run the frontend

now we can try using our server, for this open the frontend folder and run index.html in any way

6. done!

prerequisites for the current system, to make the backend work (not needed for frontend)

  • 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

code documentation

Prototype

https://www.figma.com/file/XIUfEV7DlJHJCxwN8BAz5U/Library?node-id=1%3A3

API routes

  • for this, please see routes.md in the documentation folder

technology stack

...

contributors

...

API Docs

  • 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

3dev-fullstack's People

Contributors

kwlskiy avatar valloa avatar m-aamirbakhtiar avatar i786m avatar kayla100devs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.