PostIT is a simple web application that enables friends and colleagues create groups for notifications. It is a multi-purpose system built for group-wide messaging.
You can access the hosted API here.
- New users can create accounts by signing up.
- Registered users can access the app's features by signing in.
- Authenticated users can create groups for messaging.
- Group owners/creators can add other users to their groups.
- Members of a group can post messages for others to read.
- Members of a group receive notifications when a new message is posted.
- Authenticated users can search for other users registered on the platform.
- NodeJS - a runtime environment for JavaScript outside of the browser
- ExpressJS - a framework for flexibly handling HTTP routing in NodeJS applications
- PostgreSQL - an open-source Object-Relational Database System; used for data storage
- Sequelize - a multi-dialect, promise-based Object-Relational Mapper (ORM) for NodeJS
- Webpack - a module for bundling JavaScript files for usage in a browser
- Babel - a transpiler for translating ES2015+ JavaScript code into ES5.
- Mocha - a JavaScript test framework running on NodeJS
- Chai - a BDD/TDD assertion library; used along with Mocha to define the test specifications.
- Fork this repo to your account using the fork button at the top of this GitHub page.
- Clone the repo to your local computer by running
git clone your-github-name/post-it
from your terminal.
- Navigate to the project's directory from your terminal, with the command:
cd /path/to/your/current/directory/post-it
. - Run the following command:
npm install
.
- Install PostgreSQL.
- For
development
purposes, create a database namedpostit-db-dev
. - For
testing
purposes, create a database namedpostit-db-test
. - Run the migration scripts using the command
sequelize db:migrate
. - Seed the database by running the commad
sequelize db:seed:all
- Run the command
npm run start:test
.
- Launch the app from the terminal, then test with Postman.
- Fork this repo to your account.
- Clone the repo to your local machine.
- Create your feature branch on your local machine with
git checkout -b your-feature-branch
- Ensure your code adheres to the AirBnB Javascript Style Guide.
- Commit and push your changes to your remote branch with
git push origin your-feature-branch
- Open a pull request to the master branch, and describe how your feature works.