A Reddit-like app for users to discuss and share content, built with Node and Express using Sequelize on a PostgreSQL database.
- PostgreSQL
- Yarn >= 1.5.x
- Node >=10.x
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
Clone this repo using
git clone https://github.com/csantiago132/node-reddit.git
-
Move to the appropriate directory:
cd node-reddit
-
Run
yarn install
to install dependencies -
If you don't have Postgres installed on your computer, please download and install using the installer for your operating system
-
Create the databases for the application by running the
createdb
command:
- A database to use in the application
- a database for testing the application
createdb -U postgress -w node-reddit
createdb -U postgress -w node-reddit-test
- start your database by running the following command:
pg_ctl -D /usr/local/var/postgres[VERSION NUMBER HERE] start
- If your postgres folder does not have a version number, run
pg_ctl -D /usr/local/var/postgres start
- Run the migration scripts
yarn run migrateDb
on the terminal
- this will run
sequelize db:migrate && sequelize db:migrate --env test
Your database is now ready to accept contacts
- CircleCI integration
- Jazmine test environment
- Husky pre-commit hooks (to lint and format the code)
- Add new posts to the database
- Add new comments to the database
- Upvote/downvote a post
- View all favorite post, latest comments & posts from an user
In the near future, I want to add:
- Increase and refactor tests suites
- Add coverage reports thru Coveralls
- Build a front-end and create an UI for the application
I use SemVer for versioning. For the versions available, see the tags on this repository.
- Carlos Santiago - Initial work - csantiago132
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Cory Trimm - for mentoring - github