/monthly-wrap

Comprehensive blogging platform, encompassing both front-end and back-end functionalities for publishing and managing content

Primary LanguageJavaScriptMIT LicenseMIT

The Monthly Wrap

The Monthly Wrap is a comprehensive blogging platform, encompassing both front-end and back-end functionalities for publishing and managing content.

Tech Stack Used

JavaScriptPythonGitReactTailwindCSSViteDjango

Monthly Wrap - Open for Open Source Contributors 🚀

Monthly Wrap is an open-source project. We are excited to welcome contributors from the open-source community to help us improve and grow!

Prerequisites

  • Python and pip installed (for Django)
  • Node.js and npm installed (for React)
  • Git Bash (for running bash commands)

🌟 Why Contribute?

  • Hacktoberfest Accepted: Our repository is officially recognized as part of Hacktoberfest, making your contributions count toward the annual event.
  • Contribute to Open Source: Join our community of open-source enthusiasts and make a positive impact.
  • Learn and Grow: Gain valuable experience by working on real-world projects and collaborating with experienced developers.
  • Make a Difference: Your contributions will help us enhance and expand the project for the benefit of users worldwide.

📌 How to Contribute

Please make sure to follow our Contribution Guidelines when contributing to this project.

Check Our Issues: Visit our Issues Page to explore the list of open issues.

Open Monthly Wrap on your localhost

Follow the steps below to run vite-react server and django backend server in your browser

  1. Fork the repository.

  2. Copy the URL of the Forked Repository.

  3. Use these commands in your git bash to make a clone of the repository in your pc.

SSH Github Docs

 git clone git@github.com:adityyaa-10/monthly-wrap.git

GitHub CLI

 gh repo clone adityyaa-10/monthly-wrap

HTTPS

 git clone https://github.com/adityyaa-10/monthly-wrap.git

Run backend:

  1. Change to the repository directory on your computer.
cd  monthly-wrap/server
  1. Create a virtual environment.
python  -m  venv [name of  the  virtual  env]
  1. Activate it.
source [name of  the  virtual  env]/bin/activate
  1. Install the dependencies.
(env)$ pip  install  -r  requirements.txt
  1. Set up Environment Variables

Create a .env file in the current directory.

SECRET_KEY=mysecretkey
  1. Set up database
(env)$ python  manage.py  makemigrations
(env)$ python  manage.py  migrate

Note: (env) in the beginning indicates that the terminal session now operates in the activated virtual environment.

  1. Run development server.
python  manage.py  runserver

Navigate to the url: http://127.0.0.1:8000/

Run Frontend

To run the project in your localhost server, follow these steps.

  1. Fork the repository. {Optional}

  2. Copy the URL of the repository.

  3. Move to project directory

 cd monthly-wrap/frontend/
  1. Install dependencies
 npm install
  1. Run deployment
 npm run dev
  1. Open localhost in any browser of your choice and you are good to go.

Happy contributing! 🚀