Skip to content

Dakota-Peel/skepticaltheremin

 
 

Repository files navigation

BreadCrumbs

Your world. Your map. Your breadcrumbs.

image

Table of Contents

  1. Team
  2. Usage
  3. Requirements
  4. Development
    1. Installing Dependencies
    2. API Endpoints
  5. Deployment
  6. Contributing

Team

Usage

For development, run node (or nodemon) "server.js" to begin running the server. From there, it is a good idea to run "webpack --watch" while making changes to the client-side (React.js) code, so that it re-compiles as changes are saved. If you opt not to run "webpack --watch", you will still need to run "webpack" at least once, the first time, to compile the JavaScript into a file that will be called "bundle.js".

Requirements

  • "babel": "^6.3.26",
  • "babel-core": "^6.4.0",
  • "babel-loader": "^6.2.1",
  • "babel-preset-es2015": "^6.3.13",
  • "babel-preset-react": "^6.3.13",
  • "body-parser": "^1.14.2",
  • "express": "^4.13.3",
  • "history": "^1.17.0",
  • "moment": "^2.11.0",
  • "mongoose": "^4.3.5",
  • "react": "^0.14.6",
  • "react-dom": "^0.14.6",
  • "react-router": "^1.0.3",
  • "webpack": "^1.12.10",
  • "webpack-dev-server": "^1.14.0"

Development

Installing Dependencies

From within the root directory:

npm install

API end points

URL METHOD RES BODY REQ BODY
/signup GET
/login POST
/api/users GET JSON(users) username: str
/api/users POST JSON(user) username: str, name: str, avatar: str
/api/users DELETE JSON(user) username: str
/api/maps/:username GET JSON(pin)
/api/maps/:username POST JSON(pin) pin: obj
/api/maps/:username DELETE JSON(pin) _id: str
/api/maps/:username PUT JSON(pin) _id: str, newPin: pinObj

Deployment

Make sure to exclude public/bundle.js in .gitignore while pushing to herokuapp.

Contributing

Contact any of the current Breadcrumbs team members (https://github.com/scintillating-doughnut/skepticaltheremin) to learn how to get involved in the project!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.4%
  • CSS 2.9%
  • HTML 1.7%