hypeset

Table of Contents

1. Getting Started
2. Tech Stack
3. Contributing
4. License

Getting started

1. Clone the latest version

Start by cloning the latest version of hypeset and on your local machine by running:

$ git clone https://github.com/chrisng93/hypeset.git
$ cd hypeset

2. Run frontend and backend

Follow directions in the app and server directories to get those up and running

After that open in your browser the localhost with your chosen port, e.g. http://localhost:8080/ to access the application.

Tech Stack

Front End:

• React
• Redux
• Redux Thunk
• Redux Persist
• React-Router
• React-Router-Redux
• SASS
• Reselect
• Webpack

Back End:

• Node
• Express
• PostgreSQL
• Sequelize
• Redis
• Cheerio
• Cron

Deployment:

• Docker
• Digital Ocean

File Hosting:

• Amazon S3

APIs:

• Reddit

Contributing

1. Fork the repo.
2. Clone it to your local computer
3. Cut a namespaced feature branch from master and name it appropriately
4. Make commits and prefix each commit with the type of work you were doing
5. BEFORE PUSHING UP YOUR CHANGES, rebase upstream changes into your branch, fix any potential conflicts, and then push to your fork.
6. Submit a pull request directly to the master
7. Someone else will perform code review to keep codebase clean
8. Fix any errors or issues raised by the reviewer and push the fixes as a single new commit
9. Repeat until the pull request is merged.

See CONTRIBUTING.md for contribution guidelines in detail.

License

M.I.T