This PR updates the docker-compose installation documentation and env sample to improve the setup experience. - Updates the URLs for raw files to reference main branch, which is likely where new users will be pulling from initially. This seems to be the most straightforward option; assume that advanced users who want to retrieve it from a particular tag will know to change the URL for their scenario. - Fixes an improperly stated curl command. - Adds a note that the PGPASSWORD_SUPERUSER should be URL-safe. This is required since the value is later concat into a PG_DATABASE_URL as a URL, and expected to be in proper URL format. Touches on #8597. --------- Co-authored-by: Félix Malfait <felix@twenty.com> Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
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.
-
Copy the .env.example file to .env and fill in the values.
-
Run the migrations:
npx nx run twenty-website:database:migrate
- 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