Giter Club home page Giter Club logo

ease-journal's Introduction

logo

[EASE-JOURNAL]

Flask API for Ease Journal

A Flask REST API server for a journaling application, providing users with the ability to create and manage journals, categories, and user profiles. This API serves as the backend infrastructure, offering CRUD operations for journals, categories, and users.

Getting Started

To get started with the Ease Journal Flask API, follow the setup instructions below:

  • For Production: Run make prod to build the application for production use.
  • For Development: Execute make dev_env to set up the development environment.

Features

  • User Management: Create, update, and delete user profiles. Enhanced validation ensures integrity of user data.
  • Category Management: Improved category management with validation for uniqueness and the ability to handle duplicates gracefully. Users can add, update, and delete categories for better organization of journal entries.
  • Journal Management: Users can add, update, and delete journal entries, with improvements in handling and organization.
  • Insights and Prompts: Future feature to leverage AI for offering journaling insights and prompts based on user entries.

Updates and Improvements

  • Extensive unit testing added for reliability and performance.
  • Enhanced user management features with robust validation for emails and passwords.
  • Improved category management with duplicate handling and title validation.
  • Refactored and optimized journal entry management for better usability.

Endpoints Overview

The API provides several endpoints to interact with the journaling application, including user, category, and journal management:

  • User Endpoints: /users, /users/update/<user_id>, /users/delete/<user_id>
  • Category Endpoints: /categories, /categories/update/<category_id>, /categories/<user_id>, /categories/delete/<category_id>
  • Journal Endpoints: /journals, /journals/update/<journal_id>, /journals/delete/<journal_id>

Documentation

Contributing

Contributions are welcome. Please refer to our contribution guidelines for more details.

About

Ease Journal is a journaling application designed to help users document their thoughts, reflections, and daily activities, leveraging Flask and OpenAI's GPT-3 technology for a seamless experience.

React App

For the front-end experience, visit the Ease Journal Frontend repository.

ease-journal's People

Contributors

ev2070 avatar mahmoud1813 avatar mirna-ashour avatar cody-jiang-zhihong avatar

Stargazers

 avatar

Watchers

Kostas Georgiou avatar  avatar

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.