{"id":25440874,"url":"https://github.com/diybuilds/build-journal","last_synced_at":"2025-05-15T15:33:57.165Z","repository":{"id":272743844,"uuid":"863602033","full_name":"DIYBuilds/build-journal","owner":"DIYBuilds","description":"A project jounal and snippet keeper.","archived":false,"fork":false,"pushed_at":"2024-09-29T16:25:55.000Z","size":354,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-12T03:52:06.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://build-journal.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DIYBuilds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-26T15:20:06.000Z","updated_at":"2024-11-15T11:21:39.000Z","dependencies_parsed_at":"2025-01-16T11:52:20.228Z","dependency_job_id":"c471c682-34f3-4798-84dd-633fec12882e","html_url":"https://github.com/DIYBuilds/build-journal","commit_stats":null,"previous_names":["diybuilds/build-journal"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIYBuilds%2Fbuild-journal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIYBuilds%2Fbuild-journal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIYBuilds%2Fbuild-journal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DIYBuilds%2Fbuild-journal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DIYBuilds","download_url":"https://codeload.github.com/DIYBuilds/build-journal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254367631,"owners_count":22059545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-17T12:18:46.944Z","updated_at":"2025-05-15T15:33:57.142Z","avatar_url":"https://github.com/DIYBuilds.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Build Journal - Project Management App\n\nBuild Journal is a web application that helps developers document their project ideas, development progress, and feature additions, all in one place. It also allows generating markdown project logs, providing documentation, and tracking a project from start to end.\n\n## Features\n\n- **Project Documentation**: Automatically generate detailed markdown logs for project documentation.\n- **Project Tracking**: Update your project with new features and development progress.\n- **Authentication**: Secure login using GitHub OAuth.\n- **Tech Stack**: Utilize your chosen tech stack to tailor your project setup.\n\n---\n\n## Getting Started\n\n### Prerequisites\n\nTo run the project locally, ensure you have the following:\n\n- **Node.js** (v16 or higher)\n- **npm** or **yarn** package manager\n- **MongoDB** (for database connection)\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/priyanshuverma-dev/build-journal.git\n   cd build-journal\n   ```\n\n2. **Install dependencies:**\n\n   ```bash\n   bun install\n   ```\n\n3. **Set up environment variables:**\n\n   Create a `.env` file at the root of the project and add the following:\n\n   ```bash\n   DATABASE_URL=your-database-url\n   AUTH_SECRET=your-auth-secret\n   AUTH_GITHUB_ID=your-github-client-id\n   AUTH_GITHUB_SECRET=your-github-client-secret\n   GROQ_API_KEY=your-groq-api-key\n   ```\n\n4. **Run the application:**\n\n   To run the project locally, use:\n\n   ```bash\n   bun dev\n   ```\n\n   The app should be running on `http://localhost:3000`.\n\n---\n\n## Environment Variables\n\nThe application requires the following environment variables to be set:\n\n- **`DATABASE_URL`**: MongoDB connection URL.\n- **`AUTH_SECRET`**: A secret key used for authentication sessions.\n- **`AUTH_GITHUB_ID`**: GitHub OAuth application client ID for user authentication.\n- **`AUTH_GITHUB_SECRET`**: GitHub OAuth application client secret for authentication.\n- **`GROQ_API_KEY`**: API key used for copilotkit and other project-related content via GROQ queries.\n- **`MISTRAL_API_KEY`**: API key used to generate markdown.\n\n---\n\n## Technologies Used\n\n- **Next.js**: Server-side rendering and static site generation.\n- **Tailwind CSS**: For responsive UI design.\n- **NextAuth.js**: Authentication solution with GitHub OAuth.\n- **Prisma**: Database ORM for MongoDB.\n- **Framer Motion**: Animation and interactive UI elements.\n- **AI APIs**: For markdown generation and copilotkit.\n\n---\n\n## Authentication\n\nThis project uses **GitHub OAuth** for authentication. To set up your GitHub OAuth credentials:\n\n1. Go to [GitHub Developer Settings](https://github.com/settings/developers).\n2. Create a new OAuth app.\n3. Set the callback URL to `http://localhost:3000/api/auth/callback/github`.\n4. Copy the **Client ID** and **Client Secret** into the `.env` file as `AUTH_GITHUB_ID` and `AUTH_GITHUB_SECRET`.\n\n---\n\n## Database Setup\n\nThis project uses **MongoDB** as the database. You can either host your MongoDB database on [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) or set it up locally. Add your MongoDB connection string to the `DATABASE_URL` environment variable.\n\n---\n\n## Deployment\n\nFor deploying this project, you can use platforms like **Vercel** or **Netlify** for serverless deployment. Be sure to set the necessary environment variables in the deployment environment.\n\n---\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiybuilds%2Fbuild-journal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdiybuilds%2Fbuild-journal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdiybuilds%2Fbuild-journal/lists"}