diff --git a/.babelrc b/.babelrc
index 259572759..af95e73e5 100644
--- a/.babelrc
+++ b/.babelrc
@@ -1,14 +1,22 @@
{
+ "env": {
+ "test": {
+ "presets": [["@babel/preset-env"]]
+ }
+ },
"presets": [
- ["@babel/env", {
- "targets": {
- "browsers": [
- ">0.25%",
- "not ie 11",
- "not op_mini all"
- ]
- },
- "modules": false
- }]
+ [
+ "@babel/env", {
+ "targets": {
+ "browsers": [
+ ">0.25%",
+ "not ie 11",
+ "not op_mini all"
+ ]
+ },
+ "modules": false
+ }
+ ]
],
+ "plugins": ["@babel/plugin-transform-runtime"]
}
diff --git a/.gitignore b/.gitignore
index 2ec41903e..a20ad8c27 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,10 @@ dist/
# Swap files
*.swp
+
+# Dev build stylesheets
+stylesheet.css
+stylesheet.css.map
+
+# Removing .env
+.env
diff --git a/.stylelintrc.json b/.stylelintrc.json
new file mode 100644
index 000000000..be7e869c7
--- /dev/null
+++ b/.stylelintrc.json
@@ -0,0 +1,10 @@
+{
+ "extends": ["stylelint-config-standard"],
+ "plugins": ["stylelint-scss", "stylelint-csstree-validator"],
+ "rules": {
+ "at-rule-no-unknown": null,
+ "scss/at-rule-no-unknown": true,
+ "csstree/validator": true
+ },
+ "ignoreFiles": ["build/**", "dist/**", "**/reset*.css", "**/bootstrap*.css", "dev/**"]
+}
diff --git a/README.md b/README.md
index 05bc12d80..d0b875dc5 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
# Another platformer
-
+[](https://another-platformer.netlify.app/)
[](https://codingangarita.mit-license.org/)
-[](https://github.com/ellerbrock/open-source-badges/)
+[](https://github.com/ellerbrock/open-source-badges/)
+
+
+ 
+
A Phaser 3 platformer game with ES6 support via [Babel 7](https://babeljs.io/) and [Webpack 4](https://webpack.js.org/)
that includes hot-reloading for development and production-ready builds.
@@ -11,9 +15,64 @@ Used [phaser3-project-template](https://github.com/photonstorm/phaser3-project-t
Loading images via JavaScript module `import` is also supported.
+#### You can read more about the project and how I built it [here](https://www.notion.so/Another-platfomer-252734103ed24f26a87967fd79775c7d)
+
+## How to play
+#### Check a live version of the game [here](https://another-platformer.netlify.app/).
+
+You can navigate the menus clicking the desired options.
+
+The game objective is to jump through the platforms collecting all the items you can, everytime you collect an items the platforms start moving more quickly,to move, use the keyboard arrow keys ← ↑ → ↓
+
+
+
+## How to setup the game locally
+
+To run the game locally you should clone this repository, run `npm install` to install all the project dependencies and then you can run `npm start` to start a local web server running the project.
+
+**Be aware, the game uses an `API` to submit and receive all the leaderboard data, you should setup your own `API` to mantain this feature. The section below contains relevant information describing the `API` in detail.**
+
+## Api
+
+Setting up the API is beyond the objective of this project, however here are the needed information to use the built in [api module](https://github.com/codingAngarita/another-platformer/blob/feature/game-logic/src/classes/api.js) as is, please modify it acording to your needs.
+
+The API consists of an **API_URL** `https://your-leaderboard-api-url/`, an **API_KEY** `1234567890`.
+that contains an endpoint `/scores/` making the final api url: `API_URL` + `API_KEY` + `/scores/`.
+
+The **API_URL** and **API_KEY** values should be setted up in a `.env` file in the root of the project, this `.env` file is already added to the `.gitignore` file, don't commit this file unless you don't mind the API going public. The `.env` file should look something like this:
+
+```
+# ./.env
+API_URL=https://your-leaderboard-api-url/
+API_KEY=1234567890
+```
+
+To submit a new score, the API should receive a POST request in JSON format with the following body:
+```JSON
+{
+ "user": "New Score User",
+ "score": 39
+}
+```
+To receive all the scores, the API should respond to a GET request to with no parameters, and return a JSON in this format:
+```JSON
+{
+ "result": [
+ {
+ "user": "Low score user",
+ "score": 9
+ },
+ {
+ "user": "High score user",
+ "score": 999
+ }
+ ]
+}
+```
+
## Requirements
-[Node.js](https://nodejs.org) is required to install dependencies and run scripts via `npm`.
+[npm](https://www.npmjs.com/) is required to install dependencies and run scripts via `npm`.
## Available Commands
@@ -22,10 +81,8 @@ Loading images via JavaScript module `import` is also supported.
| `npm install` | Install project dependencies |
| `npm start` | Build project and open web server running project |
| `npm run build` | Builds code bundle with production settings (minification, uglification, etc..) |
-
-## License
-
-This projects uses the MIT license.
+| `npm run test` | Runs tests on Api methods |
+| `npm run linters` | Runs JS linters |
## Modifying the code
@@ -36,3 +93,15 @@ server by running `npm start`.
After starting the development server with `npm start`, you can edit any files in the `src` folder
and webpack will automatically recompile and reload your server (available at `http://localhost:8080`
by default).
+
+Please make sure to run the linters & tests before submiting any changes.
+
+## License
+
+This projects uses the MIT license.
+
+### Assets
+
+All the assets used in this project were made by me and "Jeromimo" please reach out before using them.
+
+
diff --git a/index.html b/dev/index.html
similarity index 75%
rename from index.html
rename to dev/index.html
index 81ddc2235..dcb4e68a9 100644
--- a/index.html
+++ b/dev/index.html
@@ -4,5 +4,7 @@
+
+