Skip to content

A design oriented project focused on making activity suggestions with aesthetics in mind.

License

Notifications You must be signed in to change notification settings

johnschatner/BoringAPI

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Things to do when bored, served in random shifting color animations!
View Demo »

Report Bug · Request Feature

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

About The Project

Product Name Screen Shot

Angular single-page-application that serves random activities to do when one is bored. These activities are gathered from BoredAPI using the built-in Fetch API.

  • Random activities
  • Beautiful animations
  • Fetch states eg: calls disabled until completion response
  • Copy to clipboard
  • Fully responsive

(back to top)

Built With

  • Angular

(back to top)

Getting Started

View Demo »

To get a local copy up and running follow these simple steps.

Prerequisites

This project uses npm, please install the latest version:

  • npm
npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/johnschatner/BoringAPI.git
  2. Install NPM packages
    npm install
  3. Start a local development server
    ng serve --open

(back to top)

Usage

View Demo »

Get some ideas for activities whenever you're bored! It's live for the foreseeable future. :)

(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

Isac - isacrs.dev@gmail.com

Project Link: https://github.com/johnschatner/BoringAPI

(back to top)

About

A design oriented project focused on making activity suggestions with aesthetics in mind.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published