Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 2.26 KB

README.md

File metadata and controls

94 lines (67 loc) · 2.26 KB

OnStreak

Vercel

Overview

OnStreak is a web application designed to help users organize, track, and share their personal or professional streaks. Whether you're building daily habits, tracking goals, or sharing progress with a community, OnStreak makes it easy to make your streaks public and gain followers.

The app encourages accountability and community engagement, helping users stay consistent and motivated.

Features

  • Organize Streaks: Track your progress on various streaks and milestones.
  • Make Streaks Public: Share your streaks with a broader audience to gain followers and support.
  • Responsive Design: The app is fully responsive, ensuring a smooth experience across all devices.
  • Interactive Animations: Built with Framer Motion to enhance user experience with smooth, interactive transitions.

Live Demo

Check out the live app: onstreak.vercel.app

Technologies Used

  • Frontend: Next.js, React, Tailwind CSS
  • Animations: Framer Motion
  • Backend: Vercel (for hosting and deployment)
  • Version Control: GitHub
  • Package Manager: npm

Prerequisites

To run this project locally, ensure you have:

  • Node.js and npm installed
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/[your-username]/OnStreak.git

2.Navigate to the project directory:

cd StreakApp

3.Install the dependencies:

npm install

4.Run the development server:

npm run dev

5.App will be running at

Project Structure

components/: Contains reusable UI components used across the app.
pages/: Contains the Next.js pages for routing.
public/: Contains static assets like images and icons.
api/:backend part as its Nextapp

##Contributions Contributions are welcome! If you'd like to contribute

Fork the repository. Create your feature branch:

git checkout -b feature/your-feature-name

Commit your changes:

git commit -m 'Add some feature'

Push to the branch:

git push origin feature/your-feature-name

Open a pull request.

License

This project is licensed under the MIT License.