Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phamduylong/aliaswebbased
A digital version of the Alias game, built for Metropolia UAS
https://github.com/phamduylong/aliaswebbased
pocketbase skeleton-ui svelte sveltekit tailwindcss typescript
Last synced: 1 day ago
JSON representation
A digital version of the Alias game, built for Metropolia UAS
- Host: GitHub
- URL: https://github.com/phamduylong/aliaswebbased
- Owner: phamduylong
- License: mit
- Created: 2024-03-24T17:42:23.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T21:52:16.000Z (27 days ago)
- Last Synced: 2024-10-21T03:36:34.130Z (25 days ago)
- Topics: pocketbase, skeleton-ui, svelte, sveltekit, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://alias-web-based.vercel.app
- Size: 14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Alias Web Based
Thesis project done for my IT programme at Metropolia University of Applied Sciences. The project is a digitalized version of the popular Finnish game [Alias](https://alias.eu/about-alias).
## Setting up a local environment
### Clone the project
Run the command below to clone a local version of the repository.
```bash
git clone https://github.com/phamduylong/AliasWebBased.git
```
There should be an option to clone using SSH if you wish to.
### Managing NPM packages
Run the install command to install npm packages needed for the project.
```bash
npm install
```
If the command failed, check if you have installed Node on the local machine. If you have not, install it from [here](https://nodejs.org/en).
## Running the application
### Running PocketBase
We'll start with some environment variables. To do this, create a .env file in the root directory (do not go under any child directory as this will prevent SvelteKit from properly recognizing these variables). The content of the file should be something like this:
```
POCKETBASE_URL='http://localhost:8090/'
```
**POCKETBASE_URL** will be used to instantiate a PocketBase instance. The URL could be replaced by a PocketBase instance URL if you have decided to host it somewhere else. Localhost shall be sufficient for storing data in a local environment. If you had decide to use localhost, the command below has to be run before running the development server:
```bash
cd .\pocketbase && .\pocketbase serve
```
This will fire up the local PocketBase instance.
### Starting SvelteKit application
After everything is set up, you shall have a directory named **AliasWebBased** in your file system. Open up the terminal in this directory, and run the following command to see magic happen:
```bash
npm run dev -- --open
```
A new browser window should open with the application presenting.
## Notes
- The project is using Vercel's cron jobs to do some clean ups with database entries. Using a local server will disable this feature and entries will have to be cleaned up manually.