A collaborative web application built with Next.js 15 and modern web technologies.
- Node.js 18.17 or later
- npm 9.x or later
- Git
- Clone the repository:
git clone https://github.com/richardp23/entrepreneur-hub-mvp.git
cd entrepreneur-hub-mvp
- Install dependencies:
npm install
- Run the development server:
npm run dev
Open http://localhost:3000 to view the application.
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
- Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git add .
git commit -S -m "feat: description of your changes"
- Push your changes and create a pull request:
git push origin feature/your-feature-name
- We use ESLint and Prettier for code formatting
- Follow the TypeScript best practices
- Write meaningful commit messages following Conventional Commits
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
- 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
- Never commit sensitive information (API keys, credentials, etc.)
- Use environment variables for configuration
- Follow security best practices outlined in our Security Policy
This project is licensed under the MIT License - see the LICENSE file for details.
- Next.js team for the amazing framework
- All contributors who participate in this project