mirror of
https://github.com/twentyhq/twenty.git
synced 2024-12-23 20:13:21 +03:00
2e2b27912b
### 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>
29 lines
706 B
Markdown
29 lines
706 B
Markdown
|
|
# Twenty-Website
|
|
This used for the marketing website (twenty.com).
|
|
This is not related in anyway to the main app, which you can find in twenty-front and twenty-server.
|
|
|
|
|
|
## Getting Started
|
|
|
|
We're using Next.JS
|
|
We're using Postgres for the database. Mandatory for the website to work, even locally.
|
|
|
|
1. Copy the .env.example file to .env and fill in the values.
|
|
|
|
2. Run the migrations:
|
|
```bash
|
|
npx nx run twenty-website:database:migrate
|
|
```
|
|
|
|
3. From the root directory:
|
|
```bash
|
|
npx nx run twenty-website:dev
|
|
```
|
|
Then open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
|
|
Or to build in prod:
|
|
```bash
|
|
npx nx run twenty-website:build
|
|
npx nx run twenty-website:start
|
|
``` |