Barata-Ribeiro Blog

📔 Book of Shadows

This is my personal blog. I created this project to learn and aggregate my future notes remotely. While developing my coding skills, I created a platform to store such notes. I gave the name "Book of Shadows" as a funny way of making it the same as when people of old used grimoires to register their findings.

🚀 Tech Used

• Node.js
• Express
• EJS
• MongoDB
• Mongoose

🛠️ Project Setup

1. Clone the repository:

   git clone https://github.com/Barata-Ribeiro/barataribeiro_blog.git

2. Navigate to the project folder:

   cd barataribeiro_blog

3. Install dependencies:

   npm install

4. Setup your environment variables (.env):

   # EXPRESS CONFIGURATION
   NODE_ENV=SERVER_ENVIRONMENT (default: development)
   SESSION_SECRET_KEY=YOUR_SESSION_SECRET_KEY (default: secret_key)
   
   # MONGODB CONFIGURATION
   MONGODB_URI=YOUR_MONGODB_URI (example: mongodb+srv://[username:password@]host[/[defaultauthdb][?options]])
   MONGODB_DBNAME=YOUR_MONGODB_DATABASE_NAME (example: my_database)
   
   # JWT CONFIGURATION
   JWT_SECRET_KEY=YOUR_JWT_SECRET_KEY (default: secret_key)
   DATA_REPO_ID=YOUR_DATA_REPO_ID (This is generated by Giscus)
   DATA_CATEGORY_ID=YOUR_DATA_CATEGORY_ID (This is generated by Giscus)

5. Start the local development server:

   npm run dev

🤝 Contributing

If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

📜 License

This project is free software available under the GPLv3 license.