Skip to content

addyuchiha/vibe-expressing-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README.md for Vibe Express

Vibe Express

Vibe Express is a SaaS platform designed to capture and monetize users' awkward silences and cringe moments. This application allows users to log their "vibe events" and track monetization through a seamless interface.

Features

  • User account creation and session management with JWT authentication.
  • Logging of vibe events with timestamps, types (silence/cringe), and durations.
  • Fetching event logs and statistics per session.
  • Basic billing integration using the Stripe API to track monetized moments.

Tech Stack

  • Node.js: JavaScript runtime for building the backend.
  • Express: Web framework for Node.js to handle routing and middleware.
  • MongoDB: NoSQL database for storing user sessions, events, and monetization data.
  • Stripe: Payment processing platform for handling billing.

Project Structure

vibe-express
├── src
│   ├── config
│   ├── controllers
│   ├── middleware
│   ├── models
│   ├── routes
│   ├── services
│   ├── types
│   ├── utils
│   └── app.ts
├── .env.example
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

Getting Started

  1. Clone the repository:

    git clone <repository-url>
    cd vibe-express
    
  2. Install dependencies:

    npm install
    
  3. Set up environment variables:

    • Copy .env.example to .env and fill in the required values.
  4. Start the application:

    npm start
    

API Documentation

Refer to the individual controller files for detailed API endpoints and usage.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.

License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors