https://github.com/german-cobian/top-ranks

A javascript app where users can input their name and purported current score. It calls an API where said information is saved, for this user and for whatever other users may tap into it.
https://github.com/german-cobian/top-ranks

css html javascript webpack

Last synced: 12 days ago
JSON representation

A javascript app where users can input their name and purported current score. It calls an API where said information is saved, for this user and for whatever other users may tap into it.

• Host: GitHub
• URL: https://github.com/german-cobian/top-ranks
• Owner: German-Cobian
• License: mit
• Created: 2021-10-06T00:50:32.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2022-05-14T01:07:27.000Z (over 2 years ago)
• Last Synced: 2024-12-19T23:11:35.014Z (20 days ago)
• Topics: css, html, javascript, webpack
• Language: JavaScript
• Homepage:
• Size: 300 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# Top-Ranks

A Javascript app where users can input their name and purported current score. It calls an API (https://us-central1-js-capstone-backend.cloudfunctions.net/api/) where that information is saved, for this user or for whatever other users may tap into it. 

![Top Ranks](/src/assets/Top-ranks.png?raw=true "Top Ranks")

### Setup and Install

* Open your terminal - Windows: `Win + R`, then type `cmd` | Mac: `Command + space`, then type `Terminal`

* Navigate to a directory of your choosing using the `cd` command

* Run this command in your OS terminal: `[email protected]:German-Cobian/Leaderboard.git` to get a copy of the project

* Navigate to the project's directory using the `cd` command

* In the clone folder, run `npm install` and then `npm run build`

* To fire up the server run `npm start`

* Visit `http://localhost:8080/` in your browser to get into the app

* To start the leaderboard with a new game id open the `scoresHandle` folder in the `src` file and change few random characters in the `GAME_URL` between `games/` and `/scores/`.

* Here you will find the documentation for the [Leaderboard API service](https://www.notion.so/Leaderboard-API-service-24c0c3c116974ac49488d4eb0267ade3)

## Built With

* HTML

* CSS

* Bootstrap

* JavaScript

* Webpack

* Gitflow workflow

* Linters(Lighthouse, stylelint, Webhint, eslint)

## Author

👤 **German Cobian**

* GitHub: [@German Cobian](https://github.com/German-Cobian)

* Twitter: [@GermanCobian1](https://twitter.com/GermanCobian1)

* LinkedIn: [@German Cobian](https://www.linkedin.com/in/german-cobian/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/German-Cobian/Top-Ranks/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

Guidelines for this project supplied by [Microverse](https://github.com/microverseinc/curriculum-javascript/tree/main/leaderboard)

## 📝 License

[MIT licensed](https://github.com/German-Cobian/Top-Ranks/blob/main/LICENSE).