Simple, clean, and efficient meeting scheduling app.
- Clone this repository locally
- Navigate to the root directory and install the dependencies.
cd ZotMeet
pnpm install
- Start the development server
pnpm start
(runpnpm start --host
if you want to access the server from other devices on your network)
- The app should be viewable at
localhost:3000
by default. Changes to the code will automatically update the page. If you ranpnpm start --host
, you can access the app from other devices on your network athost-ip:3000
.
- Go to the Postgres official website and download the database for your specific OS. (Here is more information, if you get stuck)
- While running the setup, ensure that pgAdmin is downloaded alongside Postgres itself
- Once connected to the Postgres Server, Right click on databases -> create -> database, and name it
zotmeet
. - In the ZotMeet project root directory,
pnpm db:generate
will generate any updated database migrations. - Create a .env file, and set
DATABASE_URL=postgres://yourusername:yourpassword@localhost:5432/zotmeet
- Run
pnpm db:migrate
to apply all the migration changes to your local database.
- Follow the Conventional Commits specification when writing commit messages.
- E.g.,
git commit -m "feat: add this feature"
;git commit -m "fix: fix this bug"
.
- E.g.,
- Keep commits and PRs atomic.
- A PR should be a single feature or bug fix.
- A commit should be a single logical change.
If you need credentials for the .env
file, contact the project lead (Sean).
After changes to the .env file, run pnpm run check
to update SvelteKit's auto-generated environment variable types.