Skip to content

Latest commit

 

History

History
executable file
·
144 lines (93 loc) · 4.29 KB

dev-contributing.md

File metadata and controls

executable file
·
144 lines (93 loc) · 4.29 KB

Developer Contribution Guide

Installing

Before proceeding with the installation, ensure you have the following prerequisites installed on your system:

To set up the development environment, ensure you have the following tools installed:

For Visual Studio Code, consider installing the following extensions:

Clone the repository to your local machine:

git clone https://github.com/9aia/thal.git
cd thal/

Make sure to install the dependencies:

pnpm install

Project Management

At Gaia, we’re dedicated to transparent and community-driven development. Curious about what’s on the horizon or how we bring ideas to life? Dive into our roadmap to stay updated on current progress, upcoming features, and key milestones. From brainstorming sessions to prioritized tasks, we’re excited to share every step of Thal’s journey with you. Explore the resources below to stay connected and see how Thal grows with each contribution!

  • Project Overview: A summary of Thal's mission, vision, and progress.
  • Roadmap: Key milestones and planned features to guide development.
  • Backlog: A collection of tasks and ideas pending implementation.
  • Todo: The current tasks we’re working on.
  • Suggestions: Concepts and ideas under review for potential inclusion.
  • Changelog: A detailed record of updates, changes, and improvements.
  • Archived
    • Backlog: A record of ideas that have been set aside and will not be pursued.

Developing

SQL Migrations

Generate SQL migrations:

pnpm db:generate

Apply those migrations:

pnpm db:migrate

Development Server

Start the Stripe container using Docker:

pnpm run up

Start the development server on http://localhost:3000:

pnpm run dev

Testing API

For testing the API, we utilize the Vscode REST Client extension. You can find all the API requests in ./api-client folder.

Note

Remember to set the environment by opening Command Palette and selecting Rest Client: Switch Environment.

Committing

Pushing

Setup

To ensure your changes are synchronized across both GitHub and Gitea repositories, configure your origin remote with multiple push URLs:

git remote set-url --add --push origin ssh://[email protected]:2222/9aia/thal.git
git remote set-url --add --push origin [email protected]:9aia/thal.git

Pushing

Once set up, you can push your changes to both repositories with a single command:

git push

Sharing Code

// TODO

Don't forget to modify ./codeshare/co-authors.

Releasing/Deploying

https://github.com/release-it/release-it https://www.npmjs.com/package/@release-it/keep-a-changelog

Build the application for production:

pnpm run build

Locally preview production build:

pnpm run preview

Check out the deployment documentation for more information.

Useful Links

Reference

For further information, please refer to the official documentation of the relevant technologies.