Giter Club home page Giter Club logo

callback-cats-server's Introduction

Habit Tracker API


Overview

This app uses an express api to create,read,update and delete habit trackers by interacting with an HTML front end.

Technologies used

  • html, css, vanilla/javascript
  • bootstrap
  • node.js
  • jest
  • express.js
  • mongodb / mongoose / atlas
  • docker
  • github
  • slack
  • trello
  • excalidraw
  • zoom

Getting started

how to run*

  • it is recommended you have docker desktop installed on your machine.
  1. clone the Repo

  2. navigate into the project directory your terminal.

  3. run command:

    • for windows :bash _script/startDev.sh
    • for linux : sudo bash _script/startDev.sh
  4. navigate to http://localhost:3000 to view the api responses within your browser

  • terminate the docker containers by replacing startDev.sh with teardown.sh in step 3

API Endpoints

http://127.0.0.1:3000

get

- http://localhost:3000/users 
    searches database and returns ALL users if authenticated and authorized as ADMIN e.g. user.isAdmin = true;

- http://localhost:3000/users/1 
    searches database for user with the id of 1

post

- http://localhost:3000/habits
    creates a new habit tracker and stores it inside the user model which is found by the accesstoken header

post body JSON example:

            {
            "id": "654dw6e5d6s54d6f5s4",
            "username":"fakeUsername",
            "email":"[email protected]",
            "password":"fakepassword" * passwords are hashed+salted on registration"
            "habits":["array","of","habits"]
            }

mongoDB and Atlas schema

schema yet to be updated here soon...

callback-cats-server's People

Contributors

tommyhacker avatar crookedtimber 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.