/TwoLeftThumbs

Primary LanguageJavaScriptMIT LicenseMIT


Logo

Two Left Thumbs

Stackoverflow Clone
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

Two Left Thumbs is a question and answer site for passionate videogamers on all platforms. It's built and run by you as part of the Stack Exchange network of sites. With your help, we're working together to build a library of detailed answers to every question about videogames and videogame consoles.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/CroissantAhhh/TwoLeftThumbs.git

  2. Install NPM packages

    npm install

  3. Create a .env file based on the example with proper settings for your development environment

  4. Setup your PostgreSQL user, password and database and make sure it matches your .env file

  5. Run database migrations

npx sequelize-cli db:migrate
  1. Seed database
npx sequelize-cli db:seed:all

(back to top)

Usage

Signup for a new account, or login to a pre existing account.

Post a new gaming related question.

Feel free to like, comment upvote or downvote

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Afton Slone Jr - @AftonSlone - Linkedin - GitHub
Adam Guan - Linkedin - GitHub
Victor Hou - Linkedin - GitHub
Jason Zhou - Linkedin - GitHub

Project Link: https://two-left-thumbs.herokuapp.com

(back to top)