Here's a quick overview of the boilerplate and how to get started. Follow along to get your site up and running in no time.
Once you're done, you can check out the config section to learn more about the configuration options.
1. Clone the repo
After the purchase, you'll get read-only access to the private GitHub repo. You can clone it using the following command:
1git clone -o upstream "git@github.com:piotrkulpinski/nimbledocs.git" app-name
Instead of cloning, you can also fork it into your own GitHub account or download the repo as a zip file and extract it.
2. Install dependencies
Next, change into the directory and install the dependencies via PNPM (or NPM or Yarn):
1cd app-name 2 3pnpm install 4# or 5npm install 6# or 7yarn install 8# or 9bun install
3. Configure the environment variables
Copy the .env.example file to .env and update the environment variables as needed.
1cp .env.example .env
To find out more about the environment variables, check out the config section.
The .env file is ignored by Git so you don't accidentally commit your secret credentials.
4. Start the dev server
1pnpm dev 2# or 3npm run dev 4# or 5yarn dev 6# or 7bun dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying files in the app folder. The pages auto-update as you edit the files.