Table of Contents
Freshest Squid is a tool for Splatoon players to create the inkling of their dreams! The aim of Freshest Squid is to provide a useful tool for Splatoon players with a familiar UI by mimicking the menus in Splatoon.
Install the latest version of Node.js (version >= 5.0.0)
Since Freshest Squid uses ES6 features, you're going to need the latest version of Node.js installed. I recommend using Node.js 5.0.0 or greater installed to run this app, which you can install from its website.
To check what version of Node.js you currently have installed, run
$ node --version v5.0.0
Installing Node.js will also get you npm, Node's Package Manager.
$ npm --version v3.5.2
This app uses Gulp to build its assets. To run Gulp, you'll need the
gulp package installed globally on your system using npm.
$ sudo npm install -g gulp
Freshest Squid stores data in a MySQL database. You can install MySQL from its website.
Clone this repo onto your machine
$ git clone email@example.com:chrisngobanh/freshestsquid.git $ cd freshestsquid
npm install to install dependencies
$ npm install npm http GET https://registry.npmjs.org/express npm http GET https://registry.npmjs.org/gulp npm http GET https://registry.npmjs.org/nunjucks ...
Run the app!
We can use Gulp to start our app so that it can do useful things for us like recompile our assets and restart the server.
$ gulp server
Our app will run on port
8000. You can view it in your browser by visiting
BrowserSync also runs a copy of the app on port
8001, which you can view at
http://localhost:8001/. I recommend using this when you work on the app because BrowserSync will automatically update your browser as you make your changes.
The data on Freshest Squid is out of date or incorrect!
I occasionally miss Splatoon updates that add new items or weapons. In addition, I do not thoroughly check if the data I use is entirely correct.
Because of this, I need help from the community with checking keeping the data up-to-date and valid. See the How To Contribute section below if you want to help out with this!
Why is Freshest Squid so slow?
This may be because I run Freshest Squid on a low-budget VPS that also runs other web apps. If this becomes a problem, I will upgrade the server or host Freshest Squid on its own, more powerful server.
Booyah! to @erinbui for creating nearly all of the graphics used in the website.
Booyah! to /u/macguffinman for the Splatoon Gear Guide.
Booyah! to JapanYoshi for Project Paintball, the font used in Freshest Squid.
Booyah! to Inkipedia for the ability icons.
How To Contribute
I'm open to all help, from coding and design to ideas. I'd even appreciate it if you fixed typos or grammar in the comments.
Here are the ground rules:
- If ESLint doesn't approve your code, then I probably won't as well.
- You can disable some options of ESLint if you need to.
- If there's an item in
Wishlistin the Trello board, you may code it yourself and submit a pull request.
- If you have a great idea, open a new issue on it and I'll check it out!
- In addition to this, feel free to
+1any good ideas that you come across.
- Please check the Trello board or past/existing issues to see if your idea has already been suggested.
- In addition to this, feel free to
- If you're submitting a design, your best bet would be to open an issue and present your designs there. You could also code in the designs yourself and submit a pull request if you would like.
Freshest Squid is a not-for-profit open-source software released under the MIT License. See the LICENSE file for details.
Splatoon and Wii U are trademarks or registered trademarks of Nintendo. Freshest Squid is neither affiliated with nor contracted by the Splatoon development team or Nintendo.
Splatoon assets (names, images) will be used in a way that qualifies as fair use under US copyright law.