Skip to content

Latest commit

 

History

History
203 lines (144 loc) · 8.87 KB

README.md

File metadata and controls

203 lines (144 loc) · 8.87 KB
Raw

Blogger

💥Blogger is a basic blogging application which includes user to create account and post their views.

        LinkedIn Python contributions welcome License Forks Stargazers Issues Contributors

Tech Stack💻

  • Frontend: HTML/CSS
  • Backend: Django

Quick Start :

  • Fork it :

Get your own Fork/Copy of repository by clicking Fork button right upper corner.

  • Clone:
$ git clone https://github.com/harsh-9in/Blogger.git
$ cd Blogger/mysite
  • Branching
$ git checkout -b [your_branch_name]
  • Make Changes in Source Code

Setting up Project

  • Create a Virtual Environment
python3 -m venv env

  • Activate the Virtual Environment

    • On Windows 
      env\Scripts\activate
    • On Linux or MAC 
      source env/bin/activate

  • Install dependencies using

pip install -r mysite/requirements.txt
  • Setting up mandatory file
A .env.example file is present in the mysite folder you have to copy the content of .env.example and paste it into
.env file (a file to be made in the same folder as .env.example file) so that settings.py file take all the 
configurations from .env file.
  • Make migrations using
python manage.py makemigrations
  • Migrate Database
python manage.py migrate
  • Create a superuser
python manage.py createsuperuser
  • Run server using
python manage.py runserver
  • Stage your Changes and Commit
# For adding/Staging Changes

$ git add .


# For Commiting Changes

$ git commit -m "<your commit message>"
  • Push your Commit to Repo
$ git push origin <branch_name>

Project Structure

/
|- .github
|- mysite : Project Directory
|    |- blog : Application for the blogs
|    |    |- migrations : Contains files that helps us to make the changes to the database schema as per the changes done in the models.
|    |    |- static : All the static assets for the blog application
|    |    |- templates : All the application specific templates
|    |    |- __init**.py
|    |    |- admin.py : In this we register the models with the Django admin application
|    |    |- apps.py : In this we register/configure all the common files for the app
|    |    |- forms.py : Contains all the forms for the app
|    |    |- models.py : Contains all the models for the app
|    |    |- tests.py : Contains all the tests for the app
|    |    |- urls.py : Contains all the urls which are specific for the app
|    |    |- views.py : Contains all the views for the app
|    |- media : The media files related to the blogs and users
|    |- mysite : Python project package
|    |    |- __init**.py
|    |    |- asgi.py : Entry point for the ASGI servers
|    |    |- settings.py : All the configurations for your project
|    |    |- urls.py : All the URLs for the Django project
|    |    |- wsgi.py : Entry point for the WSGI servers
|    |- staticfiles : To keep the static assets like images, CSS, JavaScript
|    |- users : Application for users
|    |    |- migrations : Contains files that helps us to make the changes to the database schema as per the changes done in the models.
|    |    |- templates : All the application specific templates
|    |    |- __init__.py
|    |    |- admin.py : In this we register the models with the Django admin application
|    |    |- apps.py : In this we register/configure all the common files for the app
|    |    |- backends.py : Contains the backend specific authentication functions
|    |    |- forms.py : Contains all the forms for the app
|    |    |- models.py : Contains all the models for the app
|    |    |- tests.py : Contains all the tests for the app
|    |    |- views.py : Contains all the views for the app
|    |- db.sqlite3 : Database file created when you run the migrate command
|    |- manage.py : A command line utility
|    |- Procfile : A file required for the Heroku Web applications to define the applications process types and entry points
|    |- requirements.txt : Contains all the modules and libraries required for the project.
|    |- runtime.txt : specify the Python runtime
|- .gitignore : Contains all the files and folders which needs to be ignored while pushing the code to the Git
|- CODE_OF_CONDUCT.md : Code of Conduct to be followed
|- CONTRIBUTORS.md : See the contributors of the project
|- LICENSE.md : See the License
|- README.md : Read all the instructions releated to the project

Contribution Guidelines

Geeks behind the initiative

Project Admin

Harsh Kumar -Know more

Project Mentors

-Kajol Kumari-Know More -Swarnima Shukla-Know More -Sarath Kaul-Know More

Open Source Programs

  • Contributor's Hack 2020

    Contributor's Hack 2020 is a program that helps students grow with ""OPEN SOURCE"". This initiative by HakinCodes provides you the best platform to improve your skills and abilities by contributing to vast variety of OPEN SOURCE Projects and opportunity to interact with the mentors and the Organizing Team.

  • NJACK Winter of Code 2020

    NWoC (NJACK Winter of Code) is a program by NJACK (The Official Computer Science Club of IIT Patna) that helps students understand the paradigm of Open Source contribution and gives them real world software development experience.

  • Devscript Winter of Code 2020

    DWOC is an open source initiative taken by Devscript to help students and learners be acquainted with the different aspects that entail open source contribution. It helps the mentees get a taste of problem solving in the real world.