README.md

Nano Quotes

Nano Quotes! is an inspirational and motivatonal quote generator that calls an open source inspirational quotes api created by yours truly!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Built With

Frontend:

• Next.js
• Tailwind CSS
• App hosted on Vercel

Backend

• Node.js
• Json-server
• Server hosted on Heroku

Getting Started

To run the project:

1. Clone the repo

   git clone https://github.com/hzeghari/nano-quotes.git

2. Install NPM packages

   npm install

3. Run npm start

   npm run dev

Contributing

Any contributions you make are greatly appreciated. (If you like this project, please consider contributing to my open source API!)

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

License

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

Contact

Hamza Zeghari - Portfolio - LinkedIn @the__fortyseven on Twitter - [email protected]

Project Link: https://github.com/hzeghari/nano-quotes

Acknowledgements

• Contribute to my inspirational quotes API
• Best-README-Template

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.