Skip to content

Latest commit

 

History

History
156 lines (116 loc) · 6.1 KB

README.md

File metadata and controls

156 lines (116 loc) · 6.1 KB
Raw

🐱 Caption Meow

Caption Meow is an open-source MIT-licensed social network for cat lovers!

Introducing

The ultimate creative challenge! Every day, I provide a new photo and challenge you to come up with the wittiest, funniest, and most purr-fect caption you can think of.

My community is full of cat lovers who are always up for a good laugh, so join us and start your day with a smile right meow! You can vote for your favorite captions and compete with other users to see who can come up with the best one.

With Caption Meow, you'll never run out of hilarious cat-related content. So what are you waiting for? Sign up now and let the fun begin!

I created Caption Meow inspired by the popular project Caption Cat - I cloned it and added my own unique twist! I loved the idea of a community of cat lovers coming together to create funny and creative captions for adorable cat photos.

Preview

Caption Meow can be used through the website address captionmeow.emre.run.

Features

  • User Authentication: Users can register, login, and update their profiles.
  • Caption Voting: Users can vote for their favorite captions.
  • Post Caption: Users can post funny captions for cat images.
  • Leaderboard: Lists users with the most points and can be viewed by everyone.

Screenshots

Caption Meow Homepage Caption Meow Wall of Honor

Directory Structure

├── public
│   └── images
├── src
│   ├── components
│   │   ├── Aside.jsx
│   │   ├── Comment.jsx
│   │   ├── Header.jsx
│   │   ├── HonorUser.jsx
│   │   └── Layout.jsx
│   ├── context
│   │   ├── AfterLoginProvider.jsx
│   │   └── AuthProvider.jsx
│   ├── pages
│   │   ├── Home.jsx
│   │   ├── Login.jsx
│   │   ├── Settings.jsx
│   │   ├── Signup.jsx
│   │   └── Wall.jsx
│   ├── services
│   │   ├── cats.js
│   │   ├── comments.js
│   │   ├── firebase.js
│   │   ├── users.js
│   │   └── votes.js
│   ├── main.jsx
│   └── style.css
├── README.md
├── vercel.json
└── vite.config.js

markmap

  • public: This folder contains static assets such as images used in the project.
  • src: This is the main source code folder for the project.
    • components: This folder contains React components that can be used throughout the application, such as Aside, Comment, Header, HonorUser, and Layout.
    • context: This folder contains React context providers for managing state and passing data down the component tree, including AfterLoginProvider and AuthProvider.
    • pages: This folder contains the main pages of the application, including Home, Login, Settings, Signup, and Wall.
    • services: This folder contains JavaScript modules that provide functionality for communicating with external services or APIs, such as cats, comments, firebase, users, and votes.
    • main.jsx: This is the main entry point for the application.
    • style.css: This is the main stylesheet for the application.
  • README.md: This is the README file that provides information about the project.
  • vercel.json: This file contains configuration settings for deploying the project to the Vercel platform.
  • vite.config.js: This file contains configuration settings for the Vite development server.

Installation

  1. Clone the repository to your local machine:
  git clone https://github.com/emrecoban/caption-meow.git
  1. Navigate to the project directory:
  cd caption-meow
  1. Install the dependencies using npm:
  npm install
  npm i react-router-dom
  npm i firebase
  npm i react-firebase-hooks
  1. Start the development server:
  npm run dev
  1. Open your web browser and go to http://localhost:5173 to view the application.

Configure Firebase Don't forget to configure the Firebase Config file (src/services/firebase.js)!

That's it! You should now have the project running locally on your machine. If you encounter any issues, be sure to check the project's documentation and issue tracker on GitHub.

Contributing

Bug reports, feature requests, and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Built with

  • JavaScript
  • React
  • React Router
  • Vite
  • React Firebase Hooks
  • Firebase
    • Authentication
    • Cloud Firestore

Press

  • Caption Meow has been featured in the weekly Scrimba newsletter. scrimba-newsletter

Support

References

License

The Caption Meow is available as open source under the terms of the MIT License.