admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Website - Readme update (#8712)

Browse Source 
### Readme ideas for better getting started

Website update proposal to give an easier way to get started on the
Local Setup

---------

Co-authored-by: guillim <guillaume@twenty.com>
This commit is contained in:
Guillim
2024-11-25 17:26:39 +01:00
committed by GitHub
parent 8c7d1f923d
commit 2e2b27912b
3 changed files with 46 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
packages/twenty-website/README.md
View File

@ -7,15 +7,16 @@ This is not related in anyway to the main app, which you can find in twenty-fron
## Getting Started
We're using Next.JS
We're using Postgres for the database. Mandatory for the website to work, even locally.
Copy the .env.example file to .env and fill in the values.
1. Copy the .env.example file to .env and fill in the values.
Run the migrations:
2. Run the migrations:
```bash
npx nx run twenty-website:database:migrate
```
From the root directory:
3. From the root directory:
```bash
npx nx run twenty-website:dev
```