:pushpin: Table of Contents

• Features
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

:rocket: Features

• Totally customizable with CMS
• Show actions
• Show team
• Show the mission, values, and vision of the organization
• Transparency of current donations

:construction_worker: Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/LauraBeatris/floripamais.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:LauraBeatris/floripamais.git

Install dependencies

yarn install

Start development server

yarn dev

:postbox: Faq

Question: What are the technologies used in this project?

Answer: Next.js + Tailwind CSS.

Question Why Next.js instead of other frameworks of React out there?

Answer I chose Next.js because it has a hybrid architecture. This website has only one page and it's statically generated by fetching data from a headless CMS.

:bug: Issues

Feel free to file a new issue with a respective title and description on the Floripa+ repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

:tada: Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

:closed_book: License

Released in 2020 This project is under the MIT license.

Made with love by Laura Beatris 💜🚀