Spacelocust / realtime-sveltekit

Real-time SvelteKit

Real-time project for ESGI with SvelteKit.

Content

• Real-time SvelteKit
  • Content
  • Launch the project
  • Accounts
  • Create a quiz
  • Game lobbies
  • Libraries
  • Services
  • Makefile commands
  • E2E tests

Launch the project

Launch the project using the make start and then make db-migrate commands. Additionally, you can use the make db-fixtures command to add some fixtures to the database. You can then stop and relaunch the project using the make stop and make up commands.

You can view the project on http://localhost:5173. The database UI is available on http://localhost:8080.

Important

There is currently a bug with Vite taking a long time to optimize dependencies. Upon the first launch, it can take a few minutes for the website to respond. If the logs (make logs-app) show that Vite is optimizing dependencies, please wait for it to finish.

Accounts

Users available after running the make db-fixtures command.

Username	Password	Role
dallas	xxx	admin
bob	xxx	admin
shade	xxx	admin
karl	xxx	user
caddyman	xxx	user

You can also create one using the registration form, but they will not have the admin role.

Create a quiz

Only users with the admin role can create quizzes. A new "quizzes" link will appear in the user dropdown menu.

Game lobbies

Game lobbies are available for any logged in user.

Libraries

Librairies, frameworks and tools used in this project.

• SvelteKit
• TailwindCSS
• TypeScript
• ESLint
• Prettier
• DrizzleORM
• Superforms
• Docker
• Playwright
• shadcn-svelte
• Bun
• Vite
• PostCSS

Services

Services used by the compose.yml file.

• svelte-kit : The SvelteKit service. Container name : cc-app.
• mysql : The MySQL service. Container name : cc-mysql.
• phpmyadmin : The PHPMyAdmin service. Container name : cc-phpmyadmin.

Makefile commands

Many commands are available in the Makefile. Here are a few of them.

Command	Description
make start	Start the project, all the containers and run additional commands.
make start-nocache	Start the project and all the containers without using the cache.
make up	Start the project and all the containers.
make up-recreate	Start the project and all the containers and recreate the containers.
make stop	Stop the project and all the containers.
make restart	Restart the project and all the containers.
make down	Stop and remove the project and all the containers.
make ssh	SH into the project container.
make build-app	Build the app.
make preview-app	Preview the app.
make lint	Lint the app using ESLint + Prettier.
make format	Format the app using ESLint + Prettier.
make update	Update the dependencies with Bun.
make logs	Show the logs of the different containers.

To list all the available commands, run the make command.

E2E tests

You need to have Bun installed. You need to also make sure the project is up and running.

Launch make test-install once to install Playwright. Then, you can use the make test command to run the tests. A make test-ui command is also available to run the tests in the Playwright UI.