mirror of
https://github.com/Sendouc/sendou.ink.git
synced 2026-04-24 15:08:44 -05:00
108 lines
4.8 KiB
Markdown
108 lines
4.8 KiB
Markdown
[](https://discord.gg/sendou)
|
||
|
||
Goal of sendou.ink is to provide useful tools and resources for the Splatoon community.
|
||
|
||
Live version: [https://sendou.ink/](https://sendou.ink/)
|
||
|
||
## Technologies used
|
||
|
||
- React (via Next.JS)
|
||
- TypeScript
|
||
- Node.js
|
||
- PostgreSQL (via Prisma 2)
|
||
|
||
## A few of the features
|
||
|
||
🐙 Choose between light and dark mode
|
||
|
||
🦑 Planner tool where you can draw on any map in the game to conveniently make up game plans
|
||
|
||
🐙 Calendar that collects together all the events happening in the community
|
||
|
||
🦑 Users can make an account and submit their builds and browse builds made by others
|
||
|
||
🐙 It is possible to submit yourself as "free agent". If two FA's like each other they are notified and a new team can be founded
|
||
|
||
🦑 X Rank Top 500 results can be browsed through far more conveniently than on the official app
|
||
|
||
🐙 X Rank Top 500 leaderboards to compare yourself against other players
|
||
|
||
🦑 Form your own team, recruit players and make a profile
|
||
|
||
🐙 Build analyzer that reveals way more detailed information about builds than the game does
|
||
|
||
🦑 Salmon Run leaderboards featuring some of the best records
|
||
|
||
🐙 The most comprehensive link collection in the community
|
||
|
||
## Setting up the project locally
|
||
|
||
### Access pages that don't need database access
|
||
|
||
With the following steps you can access a few pages that don't need a database. For example: home page (`/`), build analyzer (`/analyzer`) and map planner (`/plans`)
|
||
|
||
1. Clone the project
|
||
2. Run `npm i` to install dependencies
|
||
3. Run `npm run compile` to compile translation files.
|
||
4. Run `npm run dev` to start the development server at http://localhost:3000/. (To stop the server at any time, type `Ctrl+C`.)
|
||
|
||
```
|
||
[]
|
||
```
|
||
|
||
### Access rest of the pages
|
||
|
||
In addition to the steps above the steps below enable access to rest of the pages.
|
||
|
||
5. Create a file called `.env` in the `prisma` folder. In it you need an environmental variable called `DATABASE_URL` that contains the URL to a running PostgreSQL database. For example mine looks like this while developing:
|
||
|
||
```
|
||
DATABASE_URL=postgresql://sendou@localhost:5432
|
||
```
|
||
|
||
_You can see [Prisma's guide on how to set up a PostgreSQL database running locally](https://www.prisma.io/dataguide/postgresql/setting-up-a-local-postgresql-database) for more info._
|
||
|
||
6. Use `npm run migrate` to get the database formatted with the right tables.
|
||
7. Run `npm run prebuild` to generate a few necessary JSON configuration files.
|
||
8. Seed some example data in the database by running `npm run seed`. (This seed data is incomplete – see issue #197 if you would like to improve the seed data!)
|
||
|
||
### Enable logging in
|
||
|
||
In addition to the steps above the steps below enable logging in.
|
||
|
||
9. Create a file called `.env.local` in the root folder. In it you need following variables:
|
||
|
||
```
|
||
DISCORD_CLIENT_ID="<your Discord client ID>"
|
||
DISCORD_CLIENT_SECRET="<your Discord client secret>"
|
||
JWT_SECRET="<a long, cryptographically random string>"
|
||
```
|
||
|
||
a) Go to https://discord.com/developers/applications
|
||
b) Select "New Application"
|
||
c) Go to your newly generated application
|
||
d) On the "General Information" tab both "CLIENT ID" and "CLIENT SECRET" can be found.
|
||
e) On the "OAuth2" tab add `http://localhost:3000/api/auth/callback/discord` in the list of redirects.
|
||
|
||
For `JWT_SECRET`, use a long, cryptographically random string. You can use `node` to generate such a string as follows:
|
||
|
||
```
|
||
node -e "require('crypto').randomBytes(64, function(ex, buf) { console.log(buf.toString('base64')) })"
|
||
```
|
||
|
||
Make sure to restart your server after setting these new values (`Ctrl+C` + `npm run dev`).
|
||
|
||
## Using API
|
||
|
||
If you wish to use the sendou.ink API for your own project like a Discord bot you can use the API endpoints under `https://sendou.ink/api/bot` (https://github.com/Sendouc/sendou.ink/tree/main/pages/api/bot) as long as you keep the load on my backend reasonable.
|
||
|
||
Using other endpoints isn't advised as I change those as I feel to suit the needs of the website. If the endpoints under `/bot` don't meet your use case feel free to leave an issue.
|
||
|
||
## Contributing
|
||
|
||
Any kind of contributions are most welcome! If you notice a problem with the website or have a feature request then you can submit an issue for it if one doesn't already exist.
|
||
|
||
I label [issues that should be the most approachable to contribute towards with the help wanted label](https://github.com/Sendouc/sendou.ink/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). That doesn't mean you couldn't work on other issues just ask if you need extra help with them. If you want to work on something that isn't an issue yet then just make one first so we can discuss it before you start.
|
||
|
||
If you have any questions you can either make an issue with the label question or ask it on the [Discord server](https://discord.gg/sendou) (there is a channel called `#💻-development` for this purpose).
|