diff --git a/README.md b/README.md index 09fb79e..e739b52 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,35 @@ # Laconic -Repository for `Laconic`'s website. +Repository for `Laconic`'s website. It is currently hosted on Vercel. To build it locally: -## Featured Aspects of the Stack +## Install yarn +e.g,: -- [TypeScript](https://www.typescriptlang.org/) -- [Next.js](https://nextjs.org/) +``` +npm install -g yarn +``` -## Get Started +## Set env -1. Install yarn: +``` +export NEXT_PUBLIC_DATOCMS_BYPASS_TYPE="local_json" +``` - ``` - npm install -g yarn - ``` +## Install the dependencies: -2. Create `.env`: check out which environment variables you'll need to run the project in `.env.example`. Note that if running locally, your `NEXT_PUBLIC_API` should be set to `0.0.0.0:3000`. +``` +yarn +``` -3. Install the dependencies with: +### Development - ``` - yarn - ``` +``` +yarn dev +``` -4. Start developing and watch for code changes: +### Production - ``` - yarn dev - ``` - -## Fleek Build: - -The main branch is built on Fleek: https://laconiccom.on.fleek.co/ - -## Vercel -TODO +``` +yarn build +yarn start +```