Giter Site home page Giter Site logo

butterfingers's Introduction

image

ButterFingers

Engage in a dynamic typing game website that not only meticulously tracks your statistics but also offers the exciting feature of connecting with friends for added interactive enjoyment!

Tech Stack

Client: React, Redux, CSS, Node

Server: Flask, SQLAlcemy, Alembic, postgreSQL

Live Link

https://butterfingers.onrender.com/

Demos

Typing Test

Typing Test

Results

Results

User Profile

UserProfile

Non-Friend Profile

Not Friends Profile

Features

Custom Texts

  • Users can create a custom text to run
  • Users can read/view and run other users texts
  • Users can update their texts
  • Users can delete their texts

User Profiles

  • Users can upload a profile picture
  • Users can upload a cover picture
  • Users can recieve and send friend request
  • Users can view penning friend requests, either sent or recieving
  • Users can view full profile of another user if they are friends
  • Users can view part of other users profiles if the two users are not friends
  • Users can delete friend connection
  • Users can delete request or undo a decline

Scores

  • Create a score card, by running typing tests
  • Read score card after completing a test
  • Cancel the score card from being sumbitted

Run Locally

Clone the project

    git clone https://github.com/CJThornburg/ButterFingers.git

Go to the project directory

    cd butterFingers

Install dependencies

    pipenv install -r requirements.txt
    pipenv run flask db init
    pipenv run flask db migrate
    pipenv run flask db upgrade
    pipenv run flask seed all

In seprate terminal

    cd react-app
    npm install

Start the servers

In root/ terminal

pipenv run flask run

In react-frontend/ terminal

    npm run start

Environment Variables

To run this project locally, you will need to add the following environment variables to your .env file

SECRET_KEY

DATABASE_URL

S3_BUCKET

S3_KEY

S3_SECRET

Color Reference

Color Hex
Main #323437 #323437
Secondary #2C2E31 #f8f8f8
Tertiary #E2B714 #E2B714

Roadmap

  • Site wide Highscores for featured texts will be displayed and searchable for your placement.

  • Integrate More AWS capabilites

    • Update
    • Delete

Connect

butterfingers's People

Contributors

cjthornburg avatar aa-assessment-project-manager[bot] avatar appbk avatar

Stargazers

 avatar

Watchers

 avatar

butterfingers's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.