Skip to content

Latest commit

 

History

History
203 lines (147 loc) · 6.87 KB

README.md

File metadata and controls

203 lines (147 loc) · 6.87 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

React2Asteroids

A simple game with a retro style graphics
Explore the docs »

· Report Bug · Request Feature

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

About The Project

React2Asteroids video

When I was 17 i built some simple games running inside a ms-dos terminal using C.

Those were really simple and one of them was a game where you controlled a spaceship stuck at the bottom of the screen and your goal was to avoid collision with some incoming asteroids. The technology used wasn't the best one, so it was a sort of "tech demo" of what I could make using C and a simple ms-dos terminal.

Obviously the graphics were nothing special, it was done using some simple ASCII characters.

Now, 13 years later, I'm a mobile developer and my favorite framework is React Native. So I tried to recreate a similar tech-demo using JavaScript and React Native without any game engine.

I have chosen to use again a really simple graphics using the same ASCII characters.

For now the app still doesn't have all the features it had in its time, but slowly I will implement all the features introduced at the time.

(back to top)

Built With

  • JavaScript
  • TypeScript
  • React
  • React-native

(back to top)

Getting Started

  1. Clone the repository

    HTTPS:

    git clone https://github.com/davidgarra/react2asteroids.git

    SSH:

    git clone [email protected]:davidgarra/react2asteroids.git

  2. Install dependencies using yarn

    cd react2asteroids
yarn

  3. (iOS only) Install Cocoapods and run command

    cd ios && pod install

  4. Run the application

    Android:

    yarn run android

    iOS:

    yarn run ios

(back to top)

Roadmap

  • Add unit tests
  • Randomize the number of generated asteroids
  • Add the option to pause the game
  • Add an alternative modern graphics
    • More modern graphics
    • Real-time switch
  • Save the user's records
  • Add alternative modern graphics
  • Add logging in and saving records online
  • Handle gestures to move the spaceship

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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

David Garra - Linkedin - [email protected]

Project Link: https://github.com/davidgarra/react2asteroids

(back to top)