/goalie

share goals with friends

Primary LanguageJavaScriptMIT LicenseMIT

goaly

goaly is a twitter-like clone where users can post goals for their future and create challenges to do with friends.

Check out goaly here!

Index

Feature List | Database Scheme | API Documentation |

Technologies Used

Python JavaScript React Redux Flask Postgres

Landing Page

landing-page-gif

Goal

goal-gif

Challenge

challenge-gif

Getting started

  1. Clone this repository: https://github.com/danielbuva/goalie.git

  2. Install denpendencies into the Backed and the Frontend by making a terminal for each one and then run the following:

    • backend (In base of directory):
      • Pipenv install
    • frontend :
      • npm install

  3. Create a .env file using the .envexample provided

  4. Set up your database with information from your .env and then run the following to create your database, migrate, and seed (base directory):

    • Pipenv shell
    • flask db init
    • flask db migrate
    • flask db upgrade
    • flask seed all

  5. Start the app for both backend and frontend using:

    • backend :
      • pipenv run flask run -p 8000
    • frontend :
      • npm start

Amazon Web Services S3

  • For setting up your AWS refer to this guide

Features

Goals

  • Users can create a Goal
  • Users can read/view other Goals
  • Users can update their Goals
  • Users can delete their Goals

Challenges

  • Users can create a Challenge
  • Users can read/view their own Challenges
  • Users can update their Challenges
  • Users can delete their Challenges

Follows

  • Users can follow other users
  • Users can unfollow other users

Profile

  • Users can add/edit a pfp
  • Users can add/edit their banner
  • Users can edit their bio
  • Users can see their own goals
  • Users can see their own challenges

Future Features

  • Search for challenges
  • Comunities

Connect with us on LinkedIn