Cantadas App

An awesome Project to list random pickup
And a Small Project to learn about github actions

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

(back to top)

This project is using

• 
• 

(back to top)

Getting Started

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

Installation

1. Clone the repo

   git clone git@github.com:julianosirtori/cantadas-app.git

2. Install NPM packages

   yarn

3. Start the project`

    yarn dev

(back to top)

Roadmap

• Add Changelog
• Add Pickup review [Feature request] - Pickup review
• Multi-language Support
  • Portuguese
  • English

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

How To add new pickup

Fork the project like the before section and update this file: https://github.com/julianosirtori/cantadas-app/blob/main/assets/data.json

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Juliano Sirtori - @julianosirtori

Project Link: https://github.com/julianosirtori/pick-up-line-app

(back to top)