Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.21 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.21 KB

Canary

What is Canary?

Build Status Code Climate Test Coverage Dependency Status devDependency Status

Canary is a code bragging community, built by four students at Founders & Coders London. Users are invited to brag to Canary about their coding triumphs and receive virtual applause for their breakthrough.

Why are we building Canary?

We're building Canary as a learning exercise in using Node.js for large-scale projects, as well as to provide a lifeline for needy coders in search of validation.

How is Canary built?

We followed these steps to build Canary:

  • Make Create, Read and Delete (CR-D) endpoints
  • Store tweets as JSON in memory (now obsolete, as we're using Redis)
  • Store Tweets in the file system
  • Use Cookies to restrict tweet deletion to the browser from which the tweet was originally created
  • Move Tweets to Redis
  • Deploy to Heroku
  • Add real-time updates of tweets with Socket.io
  • Hash tag functionality (for different programming languages)
  • Attach geolocation data to every clap
  • Allow users to select their own location from a map
  • Display all claps on a map
  • Username functionality
  • "Impressed" button

##How can you run Canary?

You will need to have node.js, nodemon and redis installed, plus a basic understanding of git and your terminal to get this working.

1. Clone the repo

git clone https://github.com/jmnr/canary.git

2. Install the node.js dependencies:

npm install

3. Run the Server with Nodemon:

npm run nodemon

4. Go to localhost:8000 in your browser.