README.en.md

eser.live

(For Turkish please click here)

Project Description

Not ready yet.

Technology

These are the technologies we use to build our projects:

For Frontend:

• cool lime
• Shadcn
• PostCSS

For Backend:

• Deno
• Deno KV

Prerequisites:

• Deno (recommended v1.36.2)
• Git (recommended v2.41.0)
• Pup (recommended v1.0.0-rc.7)

Setting Up the Project

Clone the GitHub repository:

$ git clone git@github.com:eser/eser.live.git

Navigate to the project directory:

$ cd eser.live

Finish configuring the project:

Copy the .env files in both pkg/api and pkg/web directories as .env.local and make the necessary changes.

While you're still in pkg/api directory, initialize the database and load some example data:

$ deno task generate

Lastly, go back to project root and start project in development mode:

$ pup start

Project Management

Currently, we do not have a management panel for the project. For this reason, we perform operations through the CLI. If deno is installed on your system, you can access the CLI through the following commands:

$ deno task api:cli

You can access predefined objects such as env, seed, profileGet, etc. through the CLI.

Examples:

Getting a profile:

await profileGet("eser", "tr");

How to Contribute

We welcome contributions from everyone. To start please read our contributing guide. If you want to help you can check out our issues. If you have any questions and/or stuck at any point, feel free to ask for help on GitHub Issues.

License

Apache 2.0, see LICENSE file for details.