Code Monkey home page Code Monkey logo

boilerplate-frontend-module-3's Introduction

Project Name

Description

Describe your project in one/two lines.

User Stories

  • 404: As an anon/user I can see a 404 page if I try to reach a page that does not exist so that I know it's my fault
  • Signup: As an anon I can sign up in the platform so that I can start saving favorite restaurants
  • Login: As a user I can login to the platform so that I can see my favorite restaurants
  • Logout: As a user I can logout from the platform so no one else can use it
  • Add Restaurants As a user I can add a restaurant so that I can share it with the community
  • List Restaurants As a user I want to see the restaurants so that I can choose one to eat
  • Search Restaurants As a user I want to search restaurants by name so that I know if it´s already in the platform
  • Add to favorites As a user I want to add a restaurant to favorite so that I can save the restaurants that I liked the most
  • See my favorites As a user I want to see my favorite restaurantes so that I can see the ones I liked the most

Backlog

User profile:

  • see my profile
  • upload my profile picture
  • see other users profile
  • list of events created by the user
  • list events the user is attending

Geo Location:

  • add geolocation to events when creating
  • show event in a map in event detail page
  • show all events in a map in the event list page

Homepage:

  • ...

Client

Pages

url public Functionality
/ true landing page
/signup true Signup user
/login true login user
/profile false profile of user

Services

  • Auth Service
    • auth.login(user)
    • auth.signup(user)
    • auth.logout()
    • auth.me()
    • auth.getUser() // synchronous
  • Restaurant Service
    • restaurant.list()
    • restaurant.search(terms)
    • restaurant.create(data)
    • restaurant.detail(id)
    • restaurant.addFavorite(id)
    • restaurant.removeFavorite(id)

Server

Models

User model

username - String // required
email - String // required & unique
password - String // required
favorites - [ObjectID<Restaurant>]

Restaurant model

owner - ObjectID<User> // required
name - String // required
phone - String
address - String

API Endpoints (backend routes)

API routes:

auth

Method Route Functionality
GET api/auth/me Check session status
POST api/auth/signup Log in user to app and set user to session (Body: username, password)
POST api/auth/login Register user to app and set user to session (Body: username, password)
POST api/auth/logout Log out user from app and remove session

Links

Trello/Kanban

Link to your trello board or picture of your physical board

Git

The url to your repository and to your deployed project

Client repository Link

Server repository Link

Deploy Link Backend

Deploy Link Frontend

Slides

The url to your presentation slides

Slides Link

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.