mirror of
https://github.com/Sendouc/sendou.ink.git
synced 2026-08-27 21:55:15 -05:00
Fancier README
This commit is contained in:
@@ -19,8 +19,6 @@ You are free to create issues about bugs, feature requests or just questions abo
|
||||
|
||||
- Tell me how I can test it and include unit / E2E tests if possible.
|
||||
|
||||
I try to review any pull requests without delay. Note that since this is my personal project I have some opinions on how the code should look. Due to this I might make some nitpicky adjustments directly to your contribution or point out even relatively minor issues in the code review.
|
||||
|
||||
## Help
|
||||
|
||||
If you need help with anything related to contributing we have [a Discord server](https://discord.gg/sendou). Especially the "development" channel is meant for this.
|
||||
|
||||
45
README.md
45
README.md
@@ -1,3 +1,40 @@
|
||||
<div style="margin:0 auto;width:250px"><img src="public/static-assets/img/app-icon.png" style="border-radius:100%"></div>
|
||||
<div style="text-align:center;font-size:2rem;"><h2><a href="https://sendou.ink" target="_blank" rel="noreferrer">sendou.ink</a><h2></div>
|
||||
<div><img src="https://dcbadge.vercel.app/api/server/sendou" style="margin:0 auto;display:block;"></div>
|
||||
|
||||
Competitive Splatoon Hub with over 20k registered users.
|
||||
|
||||
## Selected Features
|
||||
|
||||
- Map planner that lets you draw on maps and insert weapons
|
||||
- Map list generation tool
|
||||
- Win badges from tournaments, management tools for TO's
|
||||
- Calendar to find out upcoming events to play in
|
||||
- Event result reporting
|
||||
- Plus Server for top player "looking for group purposes" voting and suggestion tools.
|
||||
- User pages
|
||||
- User search
|
||||
- Object Damage Calculator (how much does each weapon deal vs. different objects)
|
||||
- Build Analyzer (exact stats of your builds)
|
||||
- Auth via Discord
|
||||
- Light and dark mode
|
||||
- Localization
|
||||
|
||||
## Tech stack
|
||||
|
||||
- React
|
||||
- Remix
|
||||
- Sqlite3
|
||||
- CSS (plain)
|
||||
|
||||
## Screenshots
|
||||
|
||||
<img src="screenshot-1.png">
|
||||
<img src="screenshot-2.png">
|
||||
<img src="screenshot-3.png">
|
||||
|
||||
---
|
||||
|
||||
## Running locally
|
||||
|
||||
### sendou.ink
|
||||
@@ -13,13 +50,9 @@ There is a sequence of commands you need to run:
|
||||
5. `npm run dev` to run the project in development mode.
|
||||
6. Navigate to `http://localhost:5800/admin`. There press the seed button to fill the DB with test data. You can also impersonate any user (Sendou#0043 = admin).
|
||||
|
||||
## Lohi
|
||||
|
||||
TODO: instructions on how to develop Lohi locally
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions very welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
||||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
||||
|
||||
### Translations
|
||||
|
||||
@@ -74,7 +107,7 @@ sendou.ink/
|
||||
│ ├── 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
|
||||
│ └── permissions.ts / -- What actions are allowed. Separated by frontend and backend as frontend has constraints based on what user sees.writing-and-organizing-tests#Folder-structure
|
||||
│ └── permissions.ts / -- What actions are allowed. Separated by frontend and backend as frontend has constraints based on what user sees.
|
||||
├── discord-bot/ -- Lohi Discord bot that works together with sendou.ink
|
||||
├── migrations/ -- Database migrations
|
||||
├── public/ -- Images, built assets etc. static files to be served as is
|
||||
|
||||
BIN
screenshot-1.png
Normal file
BIN
screenshot-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 480 KiB |
BIN
screenshot-2.png
Normal file
BIN
screenshot-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 307 KiB |
BIN
screenshot-3.png
Normal file
BIN
screenshot-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 368 KiB |
Reference in New Issue
Block a user