Skip to content

Latest commit

 

History

History
141 lines (92 loc) · 3.97 KB

readme.md

File metadata and controls

141 lines (92 loc) · 3.97 KB


ShrimplePlay

Play the Shrimple way!
View Demo · Report Bug or Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

ShrimplePlay is a free to use, open-source, gaming site with a large collection of html5, flash, mobile, and retro games to play out of the box in your browser!

(back to top)

Built With

This site was built using the following libraries and server backends

Next.js React,js

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps, if you would like to host it publicly please do the research yourself.

$ git clone https://github.com/Celestial-Dev/Celestial-Gaming
$ cd Celestial-Gaming
$ npm install
$ npm run build
$ npm run start

Prerequisites

Make sure you are on the latest version of NPM

npm install npm@latest -g

Roadmap

  • Significantly increase the size of the game library
  • Update depracated features from months ago
  • Reorganize the file structure

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License License. See LICENSE for more information.

(back to top)

Contact

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)