Zeus
Setup
💡

By now you should've the selected starter-kit on your local machine. If not, please go back to the Getting Started section and follow the instructions.

Start a local server

Since all starter-kits on veloz uses it own separate docker container, Make sure you have Docker installed on your machine before proceeding further.

📝 Configuring environment variables

  1. Rename .env.example to .env and update the values with your own credentials.

By default, the starter-kit uses Mongodb as the database. You can aswell switch to other databases like Postgres or MySQL by updating the DATABASE_URL in the .env file. Follow this instructions

.env

_33
NEXTAUTH_URL="http://localhost:4000"
_33
_33
NODE_ENV="development"
_33
_33
# local database url
_33
DATABASE_URL="mongodb://root:12345@localhost:27001/veloz-kit?authSource=admin"
_33
_33
# jwt secret
_33
JWT_SECRET="xxxxxxx"
_33
_33
# lemonsqueezy api key
_33
LEMONSQUEEZY_API_KEY="xxxxx.xxxxx.xxxx"
_33
_33
# lemonsqueezy webhook secret
_33
LEMONSQUEEZY_WEBHOOK_SECRET="wh_xxxxxxx"
_33
_33
# google oauth
_33
# if you choose to use google oauth, make sure you have the following
_33
GOOGLE_CLIENT_ID="xxxx-xxxxxxxxx.apps.googleusercontent.com"
_33
GOOGLE_CLIENT_SECRET="GOCSPX-xxxx"
_33
_33
# github oauth
_33
# if you choose to use github oauth, make sure you have the following
_33
GH_CLIENT_ID="Iv1.xxxx"
_33
GH_CLIENT_SECRET=""
_33
_33
_33
# resend email config
_33
RESEND_API_KEY="re_ErvDyEXi_Ka7ogG2HbKUH1UMm7dHJ659M"
_33
_33
# mail
_33
# replace zlyst.site with your own domain on [Resend](https://resend.com)
_33
MAIL_FROM="Veloz <[email protected]>"

  1. Initialize docker container

_10
# make sure you are in the root directory of the starter-kit
_10
# run the following command to initialize the docker container
_10
docker-compose up -d
_10
_10
# if you want to stop the container, run the following command
_10
docker-compose down

  1. Start the local server

_10
# make sure you are in the root directory of the starter-kit
_10
# run the following command to start the local server
_10
_10
# yarn
_10
yarn dev
_10
_10
# npm
_10
npm run dev

Your local server should be up and running on http://localhost:4000

Visit http://localhost:4000 (opens in a new tab) to see your app.

veloz-kit-homepage

🎉 Congratulations! You have successfully started your local server.

📝 Next steps

Let setup authentication for your app. Head over to the Authentication section to learn more.

Zeus uses Nextauth (opens in a new tab) for authentication.

By default Zeus comes with 2 built-in ways to authenticate users: OAuth and Email & Password

© Veloz 2024