Skip to content

richardp23/entrepreneur-hub-mvp

Folders and files

NameName
Last commit message
Last commit date
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 16, 2025
Jan 10, 2025
Jan 10, 2025
Jan 17, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025
Jan 10, 2025

Repository files navigation

Entrepreneur Hub MVP

A collaborative web application built with Next.js 15 and modern web technologies.

πŸš€ Quick Start

Prerequisites

  • Node.js 18.17 or later
  • npm 9.x or later
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/richardp23/entrepreneur-hub-mvp.git
cd entrepreneur-hub-mvp
  1. Install dependencies:
npm install
  1. Run the development server:
npm run dev

Open http://localhost:3000 to view the application.

πŸ“ Project Structure

entrepreneur-hub-mvp/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ frontend/            # Frontend application
β”‚   β”‚   β”œβ”€β”€ app/            # Next.js App Router pages
β”‚   β”‚   β”œβ”€β”€ components/     # Frontend UI components
β”‚   β”‚   β”œβ”€β”€ lib/           # Frontend utilities
β”‚   β”‚   β”œβ”€β”€ styles/        # Frontend styles
β”‚   β”‚   β”œβ”€β”€ types/         # Frontend types
β”‚   β”‚   └── api/           # Next.js API routes
β”‚   β”œβ”€β”€ backend/           # Backend application
β”‚   β”‚   β”œβ”€β”€ controllers/   # Request handlers
β”‚   β”‚   β”œβ”€β”€ models/       # Data models
β”‚   β”‚   β”œβ”€β”€ services/     # Business logic
β”‚   β”‚   β”œβ”€β”€ middleware/   # Custom middleware
β”‚   β”‚   └── utils/        # Helper functions
β”‚   └── database/         # Database-related files
β”‚       β”œβ”€β”€ migrations/   # Database migrations
β”‚       β”œβ”€β”€ seeds/       # Seed data
β”‚       β”œβ”€β”€ schemas/     # Database schemas
β”‚       └── scripts/     # Database maintenance scripts
β”œβ”€β”€ public/               # Static files
β”œβ”€β”€ tests/               # All application tests
β”‚   β”œβ”€β”€ frontend/       # Frontend tests
β”‚   β”œβ”€β”€ backend/        # Backend tests
β”‚   └── e2e/           # End-to-end tests
β”œβ”€β”€ docs/               # Documentation
└── config/            # Shared configuration files

πŸ›  Development Workflow

  1. Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git add .
git commit -S -m "feat: description of your changes"
  1. Push your changes and create a pull request:
git push origin feature/your-feature-name

Code Style

  • We use ESLint and Prettier for code formatting
  • Follow the TypeScript best practices
  • Write meaningful commit messages following Conventional Commits

🀝 Contributing

Please read our Contributing Guidelines for detailed information about:

  • Code of Conduct
  • Development process
  • How to report bugs
  • How to suggest new features
  • How to submit pull requests

πŸ“ Documentation

  • Component documentation is located in the docs directory
  • API documentation will be available once the backend is implemented
  • Check out our Wiki for more detailed information

πŸ”’ Security

  • Never commit sensitive information (API keys, credentials, etc.)
  • Use environment variables for configuration
  • Follow security best practices outlined in our Security Policy

πŸ“„ License

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

πŸ™ Acknowledgments

  • Next.js team for the amazing framework
  • All contributors who participate in this project