Skip to content

software-students-spring2025/2-web-app-the-loop-troop

 
 

Repository files navigation

Digital Journal App

Product vision statement

A Digital Journal App that makes it easy to write, organize, and share your thoughts, helping you stay creative and productive. It let's you edit, delete, and share your entries with other users. It also provides stats about your wordcount, so that you could keep track of your writing progresss!

User stories

User Stories

Steps necessary to run the software

Prerequisites

Ensure you have the following installed:

  • Python 3.x

  • Virtual environment

Setup and Running Instructions

  1. Clone the repository:

    git clone https://github.com/software-students-spring2025/2-web-app-the-loop-troop.git
    cd 2-web-app-the-loop-troop
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On macOS/Linux
    venv\Scripts\activate  # On Windows
  3. Install dependencies:

    pip install -r requirements.txt
  4. Set up environment variables: Create a .env file in the root directory and add the necessary configurations, such as:

     MONGO_URI="mongodb+srv://username:password@cluster.mongodb.net/?retryWrites=true&w=majority"
     MONGO_DBNAME="example_db"
     FLASK_PORT="5000"
     FLASK_ENV="development" 
  5. Run the Flask app:

    flask run

    The application should now be running at http://127.0.0.1:5000/.

Task boards

Task Boards

Wireframes

Wireframes

About

software-engineering-spring-2025-web-app-web-app-exercise created by GitHub Classroom

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 49.5%
  • HTML 43.4%
  • CSS 5.3%
  • Shell 1.8%