mirror of https://github.com/Lapikud/tipilan
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
55 lines
1.1 KiB
55 lines
1.1 KiB
# Setup |
|
|
|
## Prerequisites |
|
- Git |
|
- Bun |
|
- If on Windows, it's recommended to use WSL (Windows Subsystem for Linux) and do the following steps there. |
|
|
|
## Installation |
|
|
|
1. Clone the repository: |
|
```bash |
|
git clone https://github.com/Lapikud/tipilan.git |
|
``` |
|
2. Install bun: |
|
```bash |
|
curl -fsSL https://bun.sh/install | bash |
|
``` |
|
3. Install dependencies: |
|
```bash |
|
cd tipilan |
|
bun install |
|
``` |
|
4. Run the application: |
|
```bash |
|
bun --bun run dev |
|
``` |
|
|
|
(ONLY FOR PRODUCTION!!) Build the application: |
|
```bash |
|
bun --bun run build |
|
``` |
|
## Accessing the Application |
|
- The application is now running at `http://localhost:3000`. |
|
|
|
## Git branch |
|
- The current production branch is `main`. |
|
- Please make sure you make changes in your branch before creating a pull request. |
|
### Making git branch |
|
- Create a new branch: |
|
```bash |
|
git checkout -b <branch-name> |
|
``` |
|
- Commit your changes: |
|
```bash |
|
git add . |
|
git commit -m "<commit-message>" |
|
``` |
|
- Push your branch: |
|
```bash |
|
git push origin <branch-name> |
|
``` |
|
- Create a pull request: |
|
Go to Github, |
|
open up this project's repository and make a new pull request. |
|
```
|
|
|