Skip to content

A timeflow application built in FastAPI and IDOM

License

Notifications You must be signed in to change notification settings

sylvoslee/timeflow

Repository files navigation

Local Setup instructions

  1. Install npm
npm install -g npm
  1. Install npx
npm install -g npx
  1. Install IDOM
pip install "idom[stable]"
  1. Install Tailwind CSS
npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init
  1. Install FastAPI
pip install FastAPI
  1. Spin up the backend Fastapi dev server
cd timesheets
uvicorn backend.main:app --reload
  1. Spin up the frontend IDOM dev server
cd timesheets/idom_frontend
python3 -m run_reload.py
  1. Compile the tailwind css file
cd idom_frontend/tailwind
npm run build

Docker instructions

  • Open a git bash terminal
  • Ensure you are in the root directory of the project
  • Run sh build.sh
  • Run docker-compose up

Notes

  • Make sure to run npm run build to build the CSS before building the Docker images
  • the base_url variable has to be modified in idom_frontend/config.py depending on the set up:
    • While the service is being run on the server, change base_url to http://165.232.72.164:8000
    • While the service is being run locally only, change base_url to http://127.0.0.1:8000

About

A timeflow application built in FastAPI and IDOM

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages