mirror of
https://github.com/Sendouc/sendou.ink.git
synced 2026-05-09 04:02:40 -05:00
185295d54e
* Clean away prisma migrations
* Way to migrate WIP
* SQLite3 seeding script initial
* Fetch tournament data in loader
* CheckinActions new loader data model
* Virtual banner text color columns
* Logged in user
* Count teams
* ownTeam
* Map pool tab fully working
* Teams tab
* Fix timestamp default
* Register page
* Manage team page
* Camel case checkedInTimestamp
* Clean slate
* Add .nvmrc
* Add favicon
* Package lock file version 2
* Update tsconfig
* Add Tailwind
* Add StrictMode
* Add background color
* Auth without DB
* Revert "Add Tailwind"
This reverts commit 204713c602.
* Auth with DB
* Switch back to tilde absolute import
* Import layout
* Camel case for database columns
* Move auth routes to folder
* User popover links working
* Import linters
* User page initial
* User edit page with country
* Script to delete db files before migration in dev
* Remove "youtubeName" column
* Correct avatar size on desktop
* Fix SubNav not spanning the whole page
* Remove duplicate files
* Update README
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
Note: This is the WIP Splatoon 3 version of the site. To see the current live version checkout the [main branch](https://github.com/Sendouc/sendou.ink/tree/main)
|
|
|
|
## Running locally
|
|
|
|
Prerequisites: [nvm](https://github.com/nvm-sh/nvm)
|
|
|
|
There is a sequence of commands you need to run:
|
|
|
|
1. `nvm use` to switch to the correct Node version.
|
|
2. `npm i` to install the dependencies.
|
|
3. Make a copy of `.env.example` that's called `.env` and fill it with values.
|
|
4. `npm run migrate` to set up the database tables.
|
|
5. `npm run dev` to run both the server and frontend.
|
|
|
|
## Project structure
|
|
|
|
```
|
|
sendou.ink/
|
|
├── app/
|
|
│ ├── components/ -- React components
|
|
│ ├── core/ -- Core business logic
|
|
│ ├── db/ -- Database layer
|
|
│ ├── hooks/ -- React hooks
|
|
│ ├── routes/ -- Routes see: https://remix.run/docs/en/v1/guides/routing
|
|
│ ├── styles/ -- All .css files of the project for styling
|
|
│ └── utils/ -- Random helper functions used in many places
|
|
├── migrations/ -- Database migrations
|
|
├── cypress/ -- see: https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests#Folder-structure
|
|
├── public/ -- Images, built assets etc. static files to be served as is
|
|
└── scripts/ -- Stand-alone scripts to be run outside of the app
|
|
```
|