Giter Club home page Giter Club logo

blog-backend's Introduction

Blog - Backend

Table of Contents
  1. About The Project
  2. Built With
  3. Getting Started

About The Project

This project is a RESTful API to manage a blog, allows to create, edit and publish posts.

The application has 3 types of user:

  • Public: can only get published posts and add comments to it
  • Writer: can create, edit and submit posts
  • Editor: can approve/reject submitted posts

Detailed documentation of the API endpoints -> API documentation

There is also a simple frontend application that uses this API (click here to access the frontend repository).

Built With

The project was built using a Web API from .NET 6 and a SQL Server database.

I chose .NET because it's the backend framework I have the most experience with.

Getting Started

This project is deployed using an Azure App Service, so you can make the requests to the following URL: https://laryssablog.azurewebsites.net/

You can also run this project on your machine.

Dependencies

If you are going to execute the project on your machine, then you will need to install .NET and a SQL Server.

This is not a actually a dependency (since you can make requests directly to the endpoint) but if you want, you can execute the frontend application to see both of them running together (check the project documentation to see how to execute it):

Execution

Sample credentials

If you are using the API deployed in Azure, you can use the following user credentials for testing:

Role Email Password
Public [email protected] public
Writer [email protected] writer
Editor [email protected] editor

On your machine

After cloning this repository you will need to run the roles.sql from the Scripts folder on your database to create the user roles. If you want to use the same sample users provided above, run the users.sql on your database as well.

Then execute the following commands on the root folder:

dotnet restore
dotnet build

Access the Web API project folder (/BlogApi) and execute this one to run the project.

dotnet run

The API is now running on https://localhost:7273.

It took me about 10 hours to finish this API, from the code to the deploy.

blog-backend's People

Contributors

laryssacarvalho avatar

Watchers

 avatar

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.