Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 2.61 KB

README.md

File metadata and controls

110 lines (70 loc) · 2.61 KB

Retreat is a full-stack web application that that focuses on user experience where users may check-in on daily mood/tasks.

For more details of our current features, visit our wiki page:

Calendar landing Page

Screenshot 2023-10-25 at 22 09 03

Check In Page

Screenshot 2023-10-25 at 22 10 24

Manage Tasks Page

Screenshot 2023-10-25 at 22 09 07

Technologies Used

Frontend

  • Javascript, React, Redux, HTML, CSS

Backend

  • Python, Flask, SQLAlchemy

Features

While using Retreat, users can:

  • Create an account and login, or sign in with a demo user.
  • View a landing page of Calendar and click "check In for year/month/date" for the date they clicked.
  • Create, read, update, and delete your own categories.
  • Create, read, update, and delete tasks on categories.
  • Create, read, update your check-ins.

Endpoints

Request Purpose
GET / Navigate to the Retreat Homepage, view the check in calendar
GET /check_in View all check-in in a day. Create, Updating a check-in is by a pop-up module
GET /manage_tasks View all categories, each with all tasks. Create, Update Delete a category/task is by pop-up module

| GET /logout | Logs out a user | | POST /login | Logs in Authenticated user | | POST /signup | Creates a new user and logs them in |

Future Goals

  • AWS Image integration for uploading daily photos
  • Daily Journal

Set Up

  • Clone the repo

Back End Server

  • Open up a new terminal

  • Open up the project folder

  • Install dependencies

    pipenv install -r requirements.txt
  • Create a .env file based on the example

  • Run the following commands to open your pipenv, migrate the database, seed the database, and run the Flask app

    pipenv shell
    flask db upgrade
    flask seed all
    flask run

Front End

  • Open up another new terminal

  • Direct to the react-app folder

  • Install dependencies

    npm install
  • Start the React App

    npm start