diff --git a/packages/twenty-website/README.md b/packages/twenty-website/README.md index a37076def..07d8ddbac 100644 --- a/packages/twenty-website/README.md +++ b/packages/twenty-website/README.md @@ -1,8 +1,7 @@ +# Twenty-Website -# 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. - +This is used for the marketing website (twenty.com). +This is not related in any way to the main app, which you can find in twenty-front and twenty-server. ## Getting Started @@ -12,18 +11,22 @@ We're using Postgres for the database. Mandatory for the website to work, even l 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 -``` \ No newline at end of file +```