{"id":22427194,"url":"https://github.com/debagnik/project-walnut","last_synced_at":"2025-04-13T15:34:53.670Z","repository":{"id":264325729,"uuid":"883850371","full_name":"Debagnik/project-walnut","owner":"Debagnik","description":"A Blogging Site for small businesses and news outlets, packed with administrative features","archived":false,"fork":false,"pushed_at":"2025-04-06T15:53:05.000Z","size":281,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T16:34:19.281Z","etag":null,"topics":["blog","ejs","express","hacktoberfest","markdown","mongodb","nodejs","seo-friendly","simple-app","startup","webapp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Debagnik.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-11-05T17:22:19.000Z","updated_at":"2025-04-06T15:46:32.000Z","dependencies_parsed_at":"2024-11-24T03:25:12.084Z","dependency_job_id":"f92421da-67c1-44c6-94d8-158a0cddecb1","html_url":"https://github.com/Debagnik/project-walnut","commit_stats":null,"previous_names":["debagnik/blog-site","debagnik/project-walnut"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Debagnik%2Fproject-walnut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Debagnik%2Fproject-walnut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Debagnik%2Fproject-walnut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Debagnik%2Fproject-walnut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Debagnik","download_url":"https://codeload.github.com/Debagnik/project-walnut/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248736858,"owners_count":21153658,"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":["blog","ejs","express","hacktoberfest","markdown","mongodb","nodejs","seo-friendly","simple-app","startup","webapp"],"created_at":"2024-12-05T20:10:23.302Z","updated_at":"2025-04-13T15:34:53.648Z","avatar_url":"https://github.com/Debagnik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project Walnut\n\n![Walnut_Lycoris-Recoil](https://github.com/user-attachments/assets/e387eeb7-0bff-48b1-a277-264d28ccf0a9)   \n[Walnut the mascot](https://lycoris-recoil.fandom.com/wiki/Kurumi)\n\nWelcome to the **Project Walnut** project. It is a simple webapp for small-startups to post their blogs, or news outlets for publishing news article \n\n## Features\n\n- **User Authentication**\n  - Sign up and login functionality using secure authentication. For editors, moderators and site admins(web master)\n  - Admins can disable or enable registration from site configurations\n- **CRUD Operations**\n  - Create, read, update, and delete blog posts.\n  - proper access privilege for admin dashboard access\n  - Webmaster portal for maintaining site settings and global site config\n  - Markdown support in editors\n- **Comments Section**\n  - Users can comment on posts using disqus integration. (In progress)\n  - Comments will be saved to DB with DDoS protection (In progress)\n- **Responsive Design**\n  - Accessible on both desktop and mobile devices.\n  - Accessible Dark/light UI for better reading experience\n\n## Technologies Used\n\n- **Frontend**\n  - HTML5, CSS3, JavaScript, EJS\n- **Backend**\n  - Node.js, Express.js\n  - Database: MongoDB with Mongoose ODM\n\n## Installation\n\n1. **Clone the repository:**\n   ```bash\n   git clone https://github.com/Debagnik/project-walnut.git\n   ```\n2. **Navigate to the project directory:**\n   ```bash\n   cd project-walnut\n   ```\n3. **Install dependencies:**\n   ```bash\n   npm install\n   ```\n4. **Configure the environment variables:**\n   - Create a `.env` file and add your MongoDB URI and any other required configurations as below.\n     ```text\n     MONGO_DB_URI=mongodb://username:password@host/blog #Required\n     PORT= #Optonal, defaults to 5000\n     JWT_SECRET=your-default-jwt-secrets #Required\n     SESSION_SECRET=your-secure-session-secret #Required\n     NODE_ENV=dev-local #Defaults to dev-local use production in production scenario\n     DEFAULT_POST_THUMBNAIL_LINK=/img/placeholder.webp #Keep it as is\n     ```\n5. **Start the application:**\n   ```bash\n   npm start\n   ```\n   or on Developer machine\n   ```bash\n   npm run dev\n   ```\n\n## Usage\n\n- Access the application at `http://localhost:5000` in your web browser.\n- Register a new account or log in with existing credentials.\n- Create new blog posts, edit them, or delete if necessary.\n- View and comment on other users' posts.\n\n## Contributing\n\nI welcome all enhancement and bugfix and issue reports. Please feel free to contibute\nIf you are interested in contributing to this project:\n1. Fork the repository\n2. Create a branch from the latest release.\n3. Submit your pull request against the release branch.\n4. Please also label your PR (enhancement for adding features, Bugfix for for bug fixing PRs)\nPS: You contribution will be reviewed by codeRabbitAi and it's tone of review will be bit harsh I made it to sound like a Tsundere, but it sometimes come of rude. \n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contact\n\nFor any questions or concerns, you can reach out at [info@debagnik.in](mailto:info@debagnik.in).\n\n## Acknowledgments\nThis project is enhanced by:\n- [CodeRabbitAI](https://coderabbit.ai) - Code review assistance\n- [Tabnine AI](https://www.tabnine.com/) - Code completion support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdebagnik%2Fproject-walnut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdebagnik%2Fproject-walnut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdebagnik%2Fproject-walnut/lists"}