Welcome to Estadium!

Overview

Estadium, Inspired by Flickr, a photo sharing app where soccer fans post and comment on soccer related experiences.

estadium

Architecture

Estadium is built on a React frontend with an Express backend, using PostgreSQL as a database.

Technologies Used

  • React
  • Redux
  • Javascript
  • HTML
  • CSS
  • Express
  • Sequelize
  • PostgreSQL

Estadium Setup

  1. Clone the repo
  • git clone https://github.com/lucascostamonteiro/Estadium
  1. Install dependencies from the root directory.
  • npm install
  1. Create a POSTGRESQL user with CREATEDB and PASSWORD in PSQL.
  • CREATE USER <name> WITH CREATEDB PASSWORD <'password'>
  1. Create a .env file in the backend directory based on the .env.example found in the same directory.

  2. Enter your username and password information into your .env file along with your desired database name, a secured combination of characters for your JWT_SECRET and your desired PORT (preferably 5000).

  3. Add a proxy to your package.json file within your frontend directory, replacing or keeping the 5000 port to match your PORT configuration found in the .env file.

    • "proxy": "http://localhost:5000"
  4. Create the database, migrate and seed the models

    • npx dotenv sequelize db:create
    • npx dotenv sequelize db:migrate
    • npx dotenv sequelize db:seed:all
  5. Start the services for the backend from the backend directory:

    • npm start
  6. Start the services for the frontend from the frontend directory. Upon start of services the project should open in your default browser or you can navigate to http://localhost:3000

    • npm start

Use the demo user account or create your own account to start using Estádium.