Git Product home page Git Product logo

website-api's Introduction

Deprecation Notice

This repo is deprecated, refer to v3.0 here


omaralbeik.com

Source code for my website backend API.

Features

  • GET / POST / PUT / DELETE endpoints using Django REST Framework.
  • Modularized applications:
    • blog
    • snippets
    • projects
    • contents
  • PostgreSQL or SQLite3.
  • Results pagination and throttling.
  • CMS Admin dashboard to edit database entries.
  • Markdown support!
    • Write text in Markdown and get instant preview in the admin dashboard
    • Get text as html from the API to present in client

Dependencies

This project requires Python3 and Django to build, if they are not installed on your device, you should install them first.

Getting Started

Install Python dependencies

pip install -r requirements.txt

Initial Server Setup

1. Collect Static Files

./manage.py collectstatic
./manage.py migrate

2. Create Django Database

./manage.py makemigrations
./manage.py migrate

3. Create Admin account

./manage.py createsuperuser

Users info can be changed later from AUTHENTICATION AND AUTHORIZATION section in the admin dashboard

Running the server

./manage.py runserver -p 8000

Administration Dashboard

Server admin dashboard can be accessed by visiting the URL localhost:8000/admin

Contributing

Your feedback is always appreciated and welcomed. If you find a bug in the source code or a mistake in the documentation, you can help me by submitting an issue here. Even better you can submit a Pull Request with a fix :)

License

This repo is released under the MIT License.

website-api's People

Contributors

omaralbeik avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

taurus-code

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.