Skip to content

Latest commit

 

History

History
86 lines (49 loc) · 2.31 KB

README.md

File metadata and controls

86 lines (49 loc) · 2.31 KB
Raw

FactFlow

FactFlow is a web-based application which fetches random facts. Powered by the API Ninjas facts API.

JavaScript React TailwindCSS Vite

Features

Showcase

Demo

demo.mp4

Screenshots

Prerequisites

  • Node.js (v-14 or later)
  • npm or yarn
  • API-Ninjas API key

Installation

Initial Setup

First, head over to API-Ninjas and generate your own API-Key, it's completely free. Then, follow the below mentioned steps :

  • Clone the repository.
git clone https://github.com/sayanjit082805/FactFlow.git
cd FactFlow

  • Install dependencies with npm install

  • Create a .env file in the root directory of the project and enter your api key like this:

VITE_API_KEY = 'your-api-key'

Running

  • Start the application with npm run dev.
  • Next, open your browser and navigate to http://localhost:5173 or the port as specified by vite.

Acknowledgements

  • The API is provided by API-Ninjas.

Contributing

Contributions are always welcome!

  • Fork the repository

  • Create a new branch (git checkout -b feature-branch)

  • Commit your changes (git commit -m 'Add new feature')

  • Open a pull request

License

This project is licensed under the Unlicense License. See the LICENSE file for details.