mirror of
https://github.com/Sendouc/sendou.ink.git
synced 2026-04-25 15:56:19 -05:00
new readme
This commit is contained in:
Sendou
parent
9be73828e5
commit
02b926ec48
52
README.md
52
README.md
|
|
@ -1,5 +1,6 @@
|
|||
# 
|
||||
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/Sendouc/sendou-ink/master/sink_squid.png">
|
||||
</p>
|
||||
[](https://discord.gg/J6NqUvt)
|
||||
|
||||
Goal of sendou.ink is to provide useful tools and resources for the competitive Splatoon community.
|
||||
|
|
@ -8,55 +9,38 @@ Live version: [https://sendou.ink/](https://sendou.ink/)
|
|||
|
||||
## What's happening
|
||||
|
||||
This site was originally a full stack web development school project. It is my first time working on a web site project of my own so it has been very much a learning experience in that sense. Although make no mistake it has been through several iterations already and I still have plans to keep improving as well as adding more functionality!
|
||||
This site was originally a full stack web development school project. Since I have continued working on it as a hobby. I use a big portion of the tools offered by it myself so finding continued motivation has been easy.
|
||||
|
||||
## Technologies used
|
||||
|
||||
- React
|
||||
- TypeScript
|
||||
- Node.js
|
||||
- GraphQL (Apollo Server)
|
||||
- MongoDB (+Mongoose)
|
||||
- Python (couple different scripts to parse data)
|
||||
- Python (a couple of different scripts to parse data)
|
||||
|
||||
## Screenshot
|
||||
## A few highlight features
|
||||
|
||||
|
||||
🦑 Planner tool where you can draw on any map in the game to conveniently make up game plans
|
||||
|
||||
## Current features
|
||||
🦑 Calendar that collects together all the events happening in the community
|
||||
|
||||
🦑 [Maplist Generator](https://sendou.ink/maps)
|
||||
Fully configure and randomly generate map lists to play on.
|
||||
🦑 Users can make an account and submit their builds and browse builds made by others
|
||||
|
||||
🦑 [Rotation Viewer](https://sendou.ink/rotation)
|
||||
View the upcoming rotations in the matchmaking and mark maps as unfavored. Unfavored maps are saved without having to register.
|
||||
🦑 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
|
||||
|
||||
🦑 [Build Viewer](https://sendou.ink/builds)
|
||||
Search for builds by weapon submitted by other users.
|
||||
🦑 X Rank Top 500 results can be browsed through far more conveniently than on the official app
|
||||
|
||||
🦑 [Tournament Viewer](https://sendou.ink/tournaments)
|
||||
Browser past tournaments of the competitive scene. Included is filtering feature that allows you to find tournaments featuring certain team composition for example.
|
||||
🦑 Browse through detailed tournament results
|
||||
|
||||
🦑 [Map Planner](https://sendou.ink/plans)
|
||||
Make plans by drawing on maps using variety of tools. You can also save and load from file.
|
||||
🦑 Choose between light and dark mode as well as 10 different accent colors
|
||||
|
||||
🦑 [X Rank Leaderboards](https://sendou.ink/xleaderboard)
|
||||
X Rank (solo queue) leaderboards by weapon class. Ordered by the average of the top four historical scores.
|
||||
## Trello
|
||||
|
||||
🦑 [Top 500 Browser](https://sendou.ink/xsearch)
|
||||
Filter and browse through thousands of X Rank placements dating back to May 2018.
|
||||
I use a [Trello board](https://trello.com/b/P46kMiY9/sendouink) to keep track of the things I still need to do and that are in progress. Anyone is free to check it out to see what bugs I am aware of as well as future plans for sendou.ink.
|
||||
|
||||
🦑 [X Rank Trends](https://sendou.ink/trends)
|
||||
Draw charts based on the appearance of different of different weapons in X Rank. Easily see the impact different patches had and how weapons compare to each other.
|
||||
|
||||
🦑 [Competitive Calendar](https://sendou.ink/calendar)
|
||||
See all the upcoming events in the competitive Splatoon community on one page.
|
||||
|
||||
🦑 [Links](https://sendou.ink/links)
|
||||
Links to all sorts of useful resources about competitive Splatoon.
|
||||
|
||||
You can also log in to save up to 100 builds of your own that can include your abilities, gear as well as description of it.
|
||||
|
||||
## Installation
|
||||
## Installation (TODO: improve this)
|
||||
|
||||
1. Install [Node](https://nodejs.org/en/)
|
||||
2. Use `npm install` in the root folder
|
||||
|
|
@ -64,6 +48,8 @@ You can also log in to save up to 100 builds of your own that can include your a
|
|||
4. Use `npm run watch` in the root folder
|
||||
5. Use `npm start` in the **/react-ui** folder
|
||||
|
||||
In addition connection to MongoDB as well as a few other ENV variables need to be configured.
|
||||
|
||||
Server will run on [http://localhost:3001/](http://localhost:3001/)
|
||||
Front-end will run on [http://localhost:3000/](http://localhost:3000/)
|
||||
|
||||
|
|
|
|||
73
frontend-react/package-lock.json
generated
73
frontend-react/package-lock.json
generated
|
|
@ -1896,21 +1896,20 @@
|
|||
}
|
||||
},
|
||||
"@testing-library/dom": {
|
||||
"version": "7.2.2",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.2.2.tgz",
|
||||
"integrity": "sha512-g+gT//COYh2FgRrlgcgdkifkjqSk7wQIS7F8jbrf6yoEsh85PJUJ/QtO0bJ9QU7pQPYQgKcgqNJsOs0dlyFYag==",
|
||||
"version": "7.8.0",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.8.0.tgz",
|
||||
"integrity": "sha512-Dfk8AqRF0h6CuWxTH0nX/kbxWfCkmQtJ+7CuHej/vhd71jX+dZz5JMpxc32WFwrkwKnRoFtPgMauS8A/j8GrUg==",
|
||||
"requires": {
|
||||
"@babel/runtime": "^7.9.2",
|
||||
"@types/testing-library__dom": "^7.0.0",
|
||||
"@babel/runtime": "^7.10.2",
|
||||
"aria-query": "^4.0.2",
|
||||
"dom-accessibility-api": "^0.4.2",
|
||||
"pretty-format": "^25.1.0"
|
||||
"dom-accessibility-api": "^0.4.4",
|
||||
"pretty-format": "^25.5.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/runtime": {
|
||||
"version": "7.9.6",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.9.6.tgz",
|
||||
"integrity": "sha512-64AF1xY3OAkFHqOb9s4jpgk1Mm5vDZ4L3acHvAml+53nO1XbXLuDodsVpO4OIUsmemlUHMxNdYMNJmsvOwLrvQ==",
|
||||
"version": "7.10.2",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.10.2.tgz",
|
||||
"integrity": "sha512-6sF3uQw2ivImfVIl62RZ7MXhO2tap69WeWK57vAaimT6AZbE4FbqjdEJIN1UqoD6wI6B+1n9UiagafH1sxjOtg==",
|
||||
"requires": {
|
||||
"regenerator-runtime": "^0.13.4"
|
||||
}
|
||||
|
|
@ -1927,9 +1926,9 @@
|
|||
}
|
||||
},
|
||||
"@types/yargs": {
|
||||
"version": "15.0.4",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.4.tgz",
|
||||
"integrity": "sha512-9T1auFmbPZoxHz0enUFlUuKRy3it01R+hlggyVUMtnCTQRunsQYifnSGb8hET4Xo8yiC0o0r1paW3ud5+rbURg==",
|
||||
"version": "15.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.5.tgz",
|
||||
"integrity": "sha512-Dk/IDOPtOgubt/IaevIUbTgV7doaKkoorvOyYM2CMwuDyP89bekI7H4xLIwunNYiK9jhCkmc6pUrJk3cj2AB9w==",
|
||||
"requires": {
|
||||
"@types/yargs-parser": "*"
|
||||
}
|
||||
|
|
@ -2143,19 +2142,19 @@
|
|||
}
|
||||
},
|
||||
"@testing-library/react": {
|
||||
"version": "10.0.4",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/react/-/react-10.0.4.tgz",
|
||||
"integrity": "sha512-2e1B5debfuiIGbvUuiSXybskuh7ZTVJDDvG/IxlzLOY9Co/mKFj9hIklAe2nGZYcOUxFaiqWrRZ9vCVGzJfRlQ==",
|
||||
"version": "10.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/react/-/react-10.0.5.tgz",
|
||||
"integrity": "sha512-ExpCW9rJcs4Fd7oxWBpGim2H8aLa1u+wh3mS0vOR8iQFObiIC2wlK6x8Ty8F3relX6WfDAeONEDCt7i0nLBdEw==",
|
||||
"requires": {
|
||||
"@babel/runtime": "^7.9.6",
|
||||
"@testing-library/dom": "^7.2.2",
|
||||
"@babel/runtime": "^7.10.2",
|
||||
"@testing-library/dom": "^7.8.0",
|
||||
"@types/testing-library__react": "^10.0.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/runtime": {
|
||||
"version": "7.9.6",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.9.6.tgz",
|
||||
"integrity": "sha512-64AF1xY3OAkFHqOb9s4jpgk1Mm5vDZ4L3acHvAml+53nO1XbXLuDodsVpO4OIUsmemlUHMxNdYMNJmsvOwLrvQ==",
|
||||
"version": "7.10.2",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.10.2.tgz",
|
||||
"integrity": "sha512-6sF3uQw2ivImfVIl62RZ7MXhO2tap69WeWK57vAaimT6AZbE4FbqjdEJIN1UqoD6wI6B+1n9UiagafH1sxjOtg==",
|
||||
"requires": {
|
||||
"regenerator-runtime": "^0.13.4"
|
||||
}
|
||||
|
|
@ -2168,17 +2167,17 @@
|
|||
}
|
||||
},
|
||||
"@testing-library/user-event": {
|
||||
"version": "10.4.0",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/user-event/-/user-event-10.4.0.tgz",
|
||||
"integrity": "sha512-IaWczZ2qO7cLUefEfU7OUBLhpmGVOBEdFe9hEHS3Qu+Wl3JTknD2+XYHLY8oct4O/gA7XP9wXpmCyLVcXRYPqA==",
|
||||
"version": "10.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@testing-library/user-event/-/user-event-10.4.1.tgz",
|
||||
"integrity": "sha512-3sdJAfjT0i4aNvo0Gqod5MvZXutMXarVsLtb+r1t65AaRJY7BgMIzWgOtfM5dxRvZsc7IdXnCt9+gcWhiXk1xg==",
|
||||
"requires": {
|
||||
"@babel/runtime": "^7.9.6"
|
||||
"@babel/runtime": "^7.10.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/runtime": {
|
||||
"version": "7.10.0",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.10.0.tgz",
|
||||
"integrity": "sha512-tgYb3zVApHbLHYOPWtVwg25sBqHhfBXRKeKoTIyoheIxln1nA7oBl7SfHfiTG2GhDPI8EUBkOD/0wJCP/3HN4Q==",
|
||||
"version": "7.10.2",
|
||||
"resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.10.2.tgz",
|
||||
"integrity": "sha512-6sF3uQw2ivImfVIl62RZ7MXhO2tap69WeWK57vAaimT6AZbE4FbqjdEJIN1UqoD6wI6B+1n9UiagafH1sxjOtg==",
|
||||
"requires": {
|
||||
"regenerator-runtime": "^0.13.4"
|
||||
}
|
||||
|
|
@ -2561,9 +2560,9 @@
|
|||
}
|
||||
},
|
||||
"@types/yargs": {
|
||||
"version": "15.0.4",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.4.tgz",
|
||||
"integrity": "sha512-9T1auFmbPZoxHz0enUFlUuKRy3it01R+hlggyVUMtnCTQRunsQYifnSGb8hET4Xo8yiC0o0r1paW3ud5+rbURg==",
|
||||
"version": "15.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.5.tgz",
|
||||
"integrity": "sha512-Dk/IDOPtOgubt/IaevIUbTgV7doaKkoorvOyYM2CMwuDyP89bekI7H4xLIwunNYiK9jhCkmc6pUrJk3cj2AB9w==",
|
||||
"requires": {
|
||||
"@types/yargs-parser": "*"
|
||||
}
|
||||
|
|
@ -2655,9 +2654,9 @@
|
|||
}
|
||||
},
|
||||
"@types/yargs": {
|
||||
"version": "15.0.4",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.4.tgz",
|
||||
"integrity": "sha512-9T1auFmbPZoxHz0enUFlUuKRy3it01R+hlggyVUMtnCTQRunsQYifnSGb8hET4Xo8yiC0o0r1paW3ud5+rbURg==",
|
||||
"version": "15.0.5",
|
||||
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.5.tgz",
|
||||
"integrity": "sha512-Dk/IDOPtOgubt/IaevIUbTgV7doaKkoorvOyYM2CMwuDyP89bekI7H4xLIwunNYiK9jhCkmc6pUrJk3cj2AB9w==",
|
||||
"requires": {
|
||||
"@types/yargs-parser": "*"
|
||||
}
|
||||
|
|
@ -5640,9 +5639,9 @@
|
|||
}
|
||||
},
|
||||
"dom-accessibility-api": {
|
||||
"version": "0.4.3",
|
||||
"resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.4.3.tgz",
|
||||
"integrity": "sha512-JZ8iPuEHDQzq6q0k7PKMGbrIdsgBB7TRrtVOUm4nSMCExlg5qQG4KXWTH2k90yggjM4tTumRGwTKJSldMzKyLA=="
|
||||
"version": "0.4.4",
|
||||
"resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.4.4.tgz",
|
||||
"integrity": "sha512-XBM62jdDc06IXSujkqw6BugEWiDkp6jphtzVJf1kgPQGvfzaU7/jRtRSF/mxc8DBCIm2LS3bN1dCa5Sfxx982A=="
|
||||
},
|
||||
"dom-converter": {
|
||||
"version": "0.2.0",
|
||||
|
|
|
|||
|
|
@ -11,8 +11,8 @@
|
|||
"@rehooks/local-storage": "^2.4.0",
|
||||
"@sendou/react-sketch": "^0.5.2",
|
||||
"@testing-library/jest-dom": "^5.9.0",
|
||||
"@testing-library/react": "^10.0.4",
|
||||
"@testing-library/user-event": "^10.4.0",
|
||||
"@testing-library/react": "^10.0.5",
|
||||
"@testing-library/user-event": "^10.4.1",
|
||||
"@types/jest": "^25.2.3",
|
||||
"@types/reach__router": "^1.3.5",
|
||||
"@types/react": "^16.9.35",
|
||||
|
|
|
|||
BIN
sink-squid.png
Normal file
BIN
sink-squid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 116 KiB |
Loading…
Reference in New Issue
Block a user