sendou.ink/README.md
2019-05-09 18:25:53 +03:00

36 lines
1.1 KiB
Markdown

# sendou.ink
Competitive Splatoon Hub
Live version: [https://sendou.ink/](https://sendou.ink/)
## What's happening
I'm making this site as a school project of full stack web development. It is my first time working on a web site project of my own so it's very much a learning experience in that sense.
First working feature is searching for past results of Top 500 of X Rank in Splatoon 2. Going forward the plan is to work on different features as well as guides.
## Technologies used
* React
* Node.js
* GraphQL (Apollo)
* MongoDB (Mongoose)
* Python (couple different scripts to parse data)
## Installation
1) Install [Node](https://nodejs.org/en/)
2) Use `npm install` in the root folder
3) Use `npm install` in the **/react-ui** folder
4) Use `npm run watch` in the root folder
5) Use `npm start` in the **/react-ui** folder
Server will run on [http://localhost:3001/](http://localhost:3001/)
Frontend will run on [http://localhost:3000/](http://localhost:3000/)
## Contributing
You are welcome to create an issue or do a pull request.
## License
GNU General Public License v3.0