Skip to content

Charpell/post-it-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 

Repository files navigation

Post-it-app

PostIt is a simple application that allows friends and colleagues create groups for notifications. This way one person can post notifications to everyone by sending a message once. The application allows people create accounts, create groups and add registered users to the groups, and then send messages out to these groups whenever they want.

Features

  1. Sign Up
  2. Log in
  3. Create group
  4. Add Member to group
  5. Send broadcast message to group members

Click here for API documentation.

Prerequisites

Node Enviroment 
Git 
Firebase Database Account
Postman
Google Chrome 

Deployment

PostIt is hosted on heroku and can be accessed via this link https://post-it-app35.herokuapp.com/

Test

The mohcha framework and supertest module are used for testing our routes To test, run "mocha"

Npm Packages

 babel-cli
 babel-core
 babel-eslint
 babel-loader
 babel-preset-es2015
 babel-watch
 body-parser
 express
 firebase
 morgan
 webpack

Development Package

eslint
eslint-config-airbnb
eslint-friendly-formatter
eslint-plugin-import
eslint-plugin-jsx-a11y
eslint-plugin-react

Installation

Kindly follow the steps below to setup a local development environment.

  1. Clone this repository from a terminal git clone https://github.com/Charpell/post-it-app.git.
  2. Move into the project directory
  3. Install project dependencies npm install
  4. Create an account of firebase and set up your app
  5. Create an .env file and set the variables in .env-sample to your specified database connection
  6. Run npm run start-server

Author

Ebuka Umeh

Acknowledgments

  Andela Bootcamp Facilitators
  Andela Bootcamp BFAs
  Andela Bootcampers
  Family and Friends

About

PostIt is a simple application that allows friends and colleagues create groups for notifications. https://post-it-app35.herokuapp.com

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors