Skip to content

Repository files navigation

Jiffy

build Netlify Status Docker Pulls Release License: MIT

Jiffy is Gaucho Racing's purchase request and order tracking platform.

Check out our wiki page here to learn more.

Getting Started

Run the local development stack with Docker Compose:

# Fill Sentinel (and optional Discord/S3/Drive) secrets in example.env first.
# Pull SENTINEL_CLIENT_SECRET and SENTINEL_TOKEN from Vault app secrets `jiffy-prod`.
docker compose up --build

The development proxy serves Jiffy at:

http://localhost:10310

The API is available under:

http://localhost:10310/api

The compose stack starts:

  • jiffy: Go API server (Air hot-reload)
  • web: React/Vite frontend
  • db: PostgreSQL
  • kerbecs: local reverse proxy

Optional integrations (Discord, S3, Google Sheets) can be left blank in example.env for basic API/UI development. Auth against Sentinel requires the client secret and service-account token.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b gh-username/my-amazing-feature)
  3. Commit your Changes (git commit -m 'Add my amazing feature')
  4. Push to the Branch (git push origin gh-username/my-amazing-feature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Shoutout Jeff "jiffy" Duong (Business Lead, 2024) whose financial wizardry and acute business accumen inspired this project.

About

Purchase request and order tracking system.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages