Welcome to LaunchHub, a platform designed to help entrepreneurs pitch their startups, connect with others, and discover innovative ideas. This README file will guide you through the project setup, features, and provide due credits to the resources that made this project possible.
Check out the live version of the app here: LaunchHub
- Post Your Startup: Share your innovative ideas with the world.
- Discover Startups: Browse and search for startups from other users.
- User Accounts: Create an account to manage your startups and profile.
- View Profiles: Explore other users' profiles and their posts.
- GitHub Authentication: Log in easily using your GitHub account.
Follow these steps to set up the project locally.
Ensure you have the following installed:
- Node.js (v16.x or later)
- npm (v7.x or later) or yarn
- Git
-
Clone the Repository:
git clone git@github.com:CakeInTech/launchhub.git
-
Navigate to the Project Directory:
cd launchhub
-
Install Dependencies:
npm install
Or, if using yarn:
yarn install
-
Environment Variables: Create a
.env.local
file in the root directory and add the required environment variables. Example:NEXT_PUBLIC_API_URL=https://api.example.com GITHUB_CLIENT_ID=your-github-client-id GITHUB_CLIENT_SECRET=your-github-client-secret SANITY_PROJECT_ID=your-sanity-project-id SANITY_DATASET=your-sanity-dataset SANITY_API_TOKEN=your-sanity-api-token
-
Run the Development Server:
npm run dev
Or, if using yarn:
yarn dev
Your application will be available at
http://localhost:3000
. -
Build for Production (Optional):
npm run build npm start
Or, if using yarn:
yarn build yarn start
This project was inspired and guided by @jsMastery, a fantastic YouTube channel for learning modern technologies like Next.js. Special thanks to Adrian for the tutorials, which were instrumental in building LaunchHub.
Additionally, this project utilized Sanity.io as the backend for managing and storing content. Sanity's powerful APIs and flexible content schema made it an ideal choice for this project.
This project also provided a hands-on opportunity to dive deep into Next.js and explore its advanced features, including:
- Server-side rendering (SSR)
- Static site generation (SSG)
- API routes
- Performance optimizations
- Third-party authentication with GitHub
Contributions are welcome! If you'd like to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature
- Commit your changes:
git commit -m 'Add your feature'
- Push the branch:
git push origin feature/your-feature
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
Thank you for exploring LaunchHub! 🚀