twenty/packages/twenty-website
Guillim 2e2b27912b
Website - Readme update (#8712)
### 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>
2024-11-25 17:26:39 +01:00
..
public wrote changelog for 0.33 (#8651) 2024-11-21 16:50:08 +01:00
src Website - Readme update (#8712) 2024-11-25 17:26:39 +01:00
.env.example Added Algolia Search (#5524) 2024-05-22 12:06:00 +02:00
.eslintrc.js chore: use common eslint config for most packages (#4705) 2024-04-04 12:05:26 +02:00
.gitignore Marketing improvements 3 (#3175) 2023-12-29 11:17:32 +01:00
next.config.js Marketing improvements 3 (#3175) 2023-12-29 11:17:32 +01:00
package.json Bump 0.34.0-canary (#8675) 2024-11-22 11:53:33 +01:00
README.md Website - Readme update (#8712) 2024-11-25 17:26:39 +01:00
tsconfig.json Add proper ORM and postgres support (#3978) 2024-02-14 17:53:50 +01:00

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:

npx nx run twenty-website:database:migrate
  1. From the root directory:
npx nx run twenty-website:dev

Then open http://localhost:3000 with your browser to see the result.

Or to build in prod:

npx nx run twenty-website:build
npx nx run twenty-website:start