Git Product home page Git Product logo

journal-api's Introduction

Journaling web application

Inspiration - DayOne App, which I'm still using and happy about that.

I love to write thoughts in a notebook. This has many positive implications. But the most important thing is awareness, I live here and now, today will never happen again. This is important to remember.


The application is under development and now there is a minimal backend part. The API documentaion is available here.

Stack:

  • Fastapi
  • Postgres + asyncpg (SQLAlchemy)
  • React
  • Typescript
  • Docker, docker-compose

Quickstart with Docker

  1. Clone the repository:
git clone https://github.com/ktlog/journal-api.git
cd journal-api

  1. Rename .env.dev to .env file
    in project root and set environment variables for application:
mv .env.dev .env
echo POSTGRES_PASSWORD=postgres >> .env
echo POSTGRES_USER=postgres >> .env
echo POSTGRES_DB=journaling >> .env
echo POSTGRES_HOST=db >> .env
echo POSTGRES_PORT=5432 >> .env

echo DATABASE_URL=postgresql+asyncpg://postgres:postgres@db:5432/journaling  >> .env

echo SERVER_HOST=127.0.0.1 >> .env
echo SERVER_PORT=8000 >> .env

echo JWT_SECRET=$(openssl rand -hex 16) >> .env
  1. Finally, run:
docker compose up --build

journal-api's People

Contributors

ktlog avatar

Stargazers

jeunjetta avatar

Watchers

 avatar

Forkers

jeunjetta

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.