Skip to content

James-H007/Journa-Gami

Repository files navigation

Journa-Gami

A web application where users can journal and take care of a virtual pet at the same time. This app was created to encourage journaling with some sense of responsibility. Inspired by Tamagotchi. I've always wanted an application where you could journal more while growing alongside another pet. It wasn't until now, that I had the necessary skills in order to create such a dream.

Overview


Live Link

Start with a pet!

Create Journals!

Make Entries and earn tickets!

image

Use Tickets to feed your pet and earn their affection!

image

Getting started

  1. Clone the repository

    https://github.com/James-H007/Journa-Gami.git
    
  2. Install dependencies

    npm install
    pipenv install -r requirements.txt
  3. Create a .env file based on the example with proper settings for your development environment

    Should look like this:

    SECRET_KEY= notSecret
    DATABASE_URL=sqlite:https:///dev.db
    SCHEMA=journa_schema
  4. Make sure the SQLite3 database connection URL is in the .env file

  5. This starter organizes all tables inside the flask_schema schema, defined by the SCHEMA environment variable. Replace the value for SCHEMA with a unique name, making sure you use the snake_case convention.

  6. Get into your pipenv, migrate your database, seed your database, and run your Flask app

    pipenv shell
    flask db upgrade
    flask seed all
    flask run
  7. To run the React App in development, first enter the following code below in the terminal to start the back-end:

    pipenv run flask run
    
  8. Then run the front-end in a seperate split terminal, enter:

    npm start
    
  9. Then navigate to https://localhost:3000

Tech Stack

Technology Use Case
Python Used for backend logic
JavaScript Frontend interactivity
HTML Markup language for web development
CSS Stylesheet language for web development
React Javascript library for building user interfaces
Redux Javascript library for managing application state
Flask Python web framework
Socket.io Connections to facilitate real-time communication
Git Version control system
Postgres Relational database management system
SQLAlchemy SQL toolkit and Object-Relational Mapping (ORM)
Sqlite Lightweight in-process library
Node.js Javascript runtime environment

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages