Welcome to SetApp, an app designed to help beginner developers create their first Minimum Viable Product (MVP). This app provides valuable tips on which frameworks to use, the database schema, color schema, and step-by-step guidance on how to proceed. Powered by OpenAI, SetApp aims to simplify the MVP creation process for aspiring developers.
BlauPrint is an organization consisting of four talented developers who are passionate about helping beginners kickstart their development journey. Our team has created separate repositories for the client-side (https://github.com/blauprint/setapp-client) and server-side (https://github.com/blauprint/setapp-server) components of the app.
- Step-by-step guidance for creating your first MVP
- Framework recommendations for different aspects of your project
- Database schema suggestions
- Color schema suggestions for a visually appealing interface
- Seamless integration with OpenAI for enhanced functionality
To get started with SetApp, follow the instructions below:
- Clone the client-side repository from GitHub.
- Open a terminal and navigate to the cloned directory.
- Install the necessary dependencies by running the following command:
npm install-
Create a new file named
.envin the root directory and populate it with the required environment variables listed in thesample.envfile. -
Run the development server using the following command:
npm run dev- Access the app by opening your browser and visiting the provided
PORT(e.g.,http://localhost:3000).
- Clone the server-side repository from GitHub.
- Open a terminal and navigate to the cloned directory.
- Install the necessary dependencies by running the following command:
npm install-
Create a new file named
env.localin the root directory and populate it with the required environment variables listed in thesample.env.localfile. -
Start the development server using the following command:
npm run start:devNote: Make sure the MongoDB database is running and accessible.
Below are the environment variables required for running the SetApp app:
PORT: The port number on which the client-side app will run.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: The public key for Clerk authentication.CLERK_SECRET_KEY: The secret key for Clerk authentication.DATABASE_URL: The URL of the MongoDB database.
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: The public key for Clerk authentication.CLERK_SECRET_KEY: The secret key for Clerk authentication.NEXT_PUBLIC_BASE_URL: The base URL of the server-side app.OPENAI_API_KEY: The API key for OpenAI integration.COMPLETION_PROMPT: The prompt for OpenAI to generate suggestions.
Please ensure you have these variables set correctly for the app to function properly.
BlauPrint is built using the following technologies:
- Nest.js: A progressive Node.js framework for building efficient and scalable server-side applications.
- MongoDB with Prisma: A modern database toolkit for TypeScript and Node.js that integrates seamlessly with MongoDB.
- Next.js: A React framework for building server-side rendered and statically generated web applications.
- Redux: A predictable state container for JavaScript apps.
We welcome contributions from the community to improve and enhance BlauPrint. If you would like to contribute, please follow these guidelines:
- Fork the repository and create your branch from
main. - Make your desired changes and ensure the codebase adheres to the existing style.
- Test your changes thoroughly.
- Create a pull request describing your changes and the problem they solve.
We appreciate your contributions in making BlauPrint better for aspiring developers.
If you encounter any issues or have questions about BlauPrint, please open an issue on GitHub. Our team will be happy to assist you.
BlauPrint is released under the MIT License. Please review the license file for more details.
Thank you for choosing BlauPrint as your guide to create your first MVP! We hope you find this app helpful on your development journey. Happy coding!