diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12707291c..6757a1dc2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 6ded26b73..40d1fae02 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ +
+

sendou.ink

+
+ +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 + + + + + +--- + ## 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 diff --git a/screenshot-1.png b/screenshot-1.png new file mode 100644 index 000000000..9c92fb023 Binary files /dev/null and b/screenshot-1.png differ diff --git a/screenshot-2.png b/screenshot-2.png new file mode 100644 index 000000000..715f78597 Binary files /dev/null and b/screenshot-2.png differ diff --git a/screenshot-3.png b/screenshot-3.png new file mode 100644 index 000000000..d2cf54344 Binary files /dev/null and b/screenshot-3.png differ