Bootcamp-LOS-24-PostIt

I (Dinobi) took on the development of this project as part of the requirements to become a fellow at Andela.

PostIt

About

Communicate Group Messages Instantly

PostIt is an open source web application built to allow family, friends and colleagues share prioritized messages as broadcast in a fun way anytime.

Features

• Personalized dashboard UI for users with access

• Holistic view of every feature of the app from a welcome screen

• Create group, search and add family/friends/colleagues who already have an account to your broadcast group

• Post messages with added advantage of using wikipedia search right from you dashboard

• Get email notification for prioritized messages.

• Have fun.

  Access PostIt

Technology Stack (PERN)

Client Side:

- Front End Organization in REACT and REDUX
- Uses SASS for styling and WEBPACK for bundling

Serve Side:

- Back end implementation is built on NODE, using
EXPRESS as the server and SEQUELIZE as the ORM for
communicating with the POSTGRES DB.

Authentication and Code Base Organization

- Written in ES6 and uses BABEL for transpiling down
to ES5 and JWT for authentication.  

Style Checking and Best Practices

- Uses ESLINT which was configured to use Airbnb-base rules for style checking

Usage

Installation and Dependencies

1. Install node, version 5 or greater is required

2. Install postgres

3. Clone the repo and cd into it

   git clone https://github.com/dinobi/Bootcamp-LOS-24-POSTIT.git
   cd Bootcamp-LOS-24-POSTIT
   

4. Install dependencies

   npm install
   

5. Configure Postgres

   In the application root directory, use the config settings in
   `server/config/config.js` to setup your postgres db
   

6. Run database migrations

   $ sequelize db:migrate
   

7. Build the assets and start the app

   - npm run build
   - npm start
   

Testing

The app uses Mocha/Chai and Chai-Http for backend testing, and Jest for frontend testing

• install Mocha, nyc and jest-cli globally: npm i mocha nyc jest-cli -g

• npm test-dev - run the unit test suite
• npm test - run the unit test for backend and display code coverage result
• client-test - run the unit test for frontend and display code coverage result

Api Docs

The PostIt api documentation source is located in the server/api-docs directory, while the documentation site is:

• api-docs

Contributing

Check the contributing file, it contains everything you need to know.

Credits

A big thank you to Temi Lajumoke, Franklin, Philip Newman, Victoria, Tracy, Femi and all of LOS-30 Andelans for their support and encouragement.

License

MIT

FAQ

Is this an Open-Source Application?

Yes it is, and contributing to the development of this
application is by raising PRs

Who can contribute?

Anyone!. This application is open to all those who want to
contribute to open-source development and are willing to follow
set standards for contributing.

Is there a set standard for PRs to this repository?

Yes, there are set conventions for PRs to this repository and can be found
in the project wiki.

What language was used to develop this application?

This project is a full stack Javascript application

Can I clone this application for personal use?

Yes!. This application is licensed under MIT, and is open for
whatever you may choose to use it for.