Bingo Companion App API

This project was developed for the purposes of being a part of my web portfolio. See it in action here.

• Description
• Requirements
• Installation and setup
  • Install
  • Run
• Environment Variables
  • MongoDB
  • Secrets
  • Google App Password
  • Email Template
• License

Description

RESTful API served with Node.js and powered by Express that provides the back-end functionality to a React web application. You can find that front-end repo along with its own setup instructions here.

Requirements

MongoDB is used as the database for this project and will require its URI connection string to be set as an env variable. The server will not start until a database connection is established.

Gmail auth is used for nodemailer SMTP transport config to simply send a password reset link to a specified email. This requires having a Google account with two-factor authorization and obtaining an app password which should be set as an env variable. See this guide here for more details.

Installation and setup

Install

• Download zip or clone: git clone https://github.com/antmercado94/bingocompanionapp-api.git
• Install dependencies using npm: npm install

Run

Start node server:

npm run start

Or run nodemon for local development:

npm run dev

Environment Variables

Several functionalities within this project require the use of environment variables. These variables should be set inside of a .env file (local dev) or within a web host's configuration.

MongoDB

• MONGO_URL=YOURCONNECTIONSTRING

Secrets

• ACCESS_TOKEN_SECRET=YOURSECRET
• RESET_TOKEN_SECRET=YOURSECRET

Google App Password

• ADMIN_APP_PW=YOURPASSWORD

Email Template

• ADMIN_EMAIL=YOUREMAIL
• CLIENT_HOST=YOURFRONTENDHOST
• HOME_URL=YOURHOMEURL
• LOGO_PATH=LOGOURL

License

Code released under the MIT license.