Game Night

An app for boardgame enthusiasts who attend in-person gaming meetups.

View Demo - Report Bug - Request Feature

About The Project

This is my capstone project for my study with Techtonica.

Why?

• I was challenged to build a PERN stack app harnessing at least one external API.
• I love board games!
• I learn best while doing.

Built With

• Node.js
• React.js
• postgreSQL
• express
• Sass
• Docker
• Heroku

Getting Started

Prerequisites

Docker

This project relies on Docker to run the PostgreSQL server. You must install Docker first before continuing.

Use one of these methods:

• Use Homebrew on macOS: brew install --cask docker
• Follow the instructions on the Docker website

Once you've installed Docker Desktop, you'll need to launch the app. On macOS, it's located in /Applications/Docker.

Node and npm

You'll need to install Node v16 and npm v8 or above. nvm is highly recommended.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://www.boardgameatlas.com/api/docs

2. Clone the repo

   git clone https://github.com/tabbykatz/game-night.git

3. Install NPM packages

   npm install

4. Copy the example environment files. You will need to configure Auth0 and use your own values.

   cp .env.example .env

   cd app
   cp .env.example .env

5. Initialize the database.

   npm run db:init

6. Run

   npm start

Roadmap

• Email invites to friends
• Unified accounts with Auth0
• Add events to calendar
• Event chat
• Light and Dark Modes

See the open issues for a full list of proposed features (and known issues).

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 app better, please fork the repo and create a pull request. You can also simply open an issue with the label "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

License

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

Contact

Tabitha O'Melay - @tabby__katz - tomelay@gmail.com

Game Night: See it on Heroku

Acknowledgments

• George Song for Mentorship 🧑🏻‍🏫 and Inspiration 🎆
• express-react-project-starter
• Josh W. Comeau

Contributors

Thanks goes to these wonderful people (emoji key):

Tabitha O'Melay 💻 🖋 🎨 📖 🤔 🐛 ⚠️

George Song 💻 👀 🐛 🚇 🚧

Kevin Clark 🤔 👀

This project follows the all-contributors specification. Contributions of any kind welcome!