Postit

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.

Development

This application was developed using NodeJs with express for routing and Firebase for data persistence.

Installation

• Make sure you have NodeJs installed on your local machine.
• Clone the repository $ git clone https://github.com/Andela-ddiei/Postit.git
• Change into the directory $ cd /PostIt
• Install all required dependencies with $ npm install
• Create a .env file in your root directory as described in .env.sample file
• Create a Firebase account
• Initialize Firebase

Testing

N/A

Usage

• Start the application $ npm start
• Use Postman to consume available endpoints
• A user can:
  • Create an account
  • Sign in
  • Sign out
  • Update profile
  • Reset password
  • Create a group
  • Get a particular group
  • Delete a group
  • Update a group
  • Get all groups
  • Join a group
  • create a message
  • Edit a message
  • Delete a message

Endpoints

Request type	Endpoint	Action
POST	/users/signup	Create a user
POST	/users/signin	Log a user in
POST	/users/signout	Sign a user out
PUT	/users/:id	Update a user's profile
POST	/groups/create	Create a group
GET	/groups/:id	Get a particular group
DELETE	/groups/:id	Delete a group
PUT	/groups/:id	Update a group
GET	/groups	Get all groups
PUT	/users/:id	Update a user's profile
POST	/groups/:id/join	Join a group
POST	/groups/:id/message	Send a message to a group
PUT	/groups/:id/message/:id	Edit a message
DELETE	/groups/:id/message/:id	Delete a message