Code Monkey home page Code Monkey logo

blog-platform-api's Introduction

blog platform API

This is the server of a fullstack blog-platform-app
blog-platform-client is here

Build Status Badge

Deployed here

Table of Contents

About

This is a API created using node.js and express. Client app is here.

  • Prisma ORM with MongoDB.
  • Routes: user, posts, comments, likes, follow.
  • Controllers for this routes.
  • JWT authentication.
  • Generating an avatar when creating a new account using the jdenticon library.
  • Dockerfile configuration.
  • Docker-compose configuration: express-app, database and client-app containers.

Built with

node.js express prisma mongodb docker docker-compose

Getting started

Prerequisites

⚠️ Before installing the project latest version of npm should be installed.

npm install -g npm@latest

⚠️ You will also need Docker. It can be installed from the official Docker website.

Installing

  1. Clone the repo with API:
git clone https://github.com/dmitrygvl/blog-platform-API.git
  1. Clone the repo with client app:
git clone https://github.com/dmitrygvl/blog-platform-client.git
  1. Open a terminal (or command line) and go to the root directory of the server:
cd blog-platform-API
  1. Rename the .env.local file to .env:
mv .env.sample .env
  1. Rename the env.local file to env:
mv .env.sample .env
  1. Set your secret key in the env file. it can be any string:
SECRET_KEY='YOUR_SECRET_KEY'
  1. Run the docker build command. The blog-platform-API and blog-platform-client folders must be in the same directory:
docker compose up
  1. Open your browser and go to http://localhost:80 to see the running project.

License

MIT License

blog-platform-api's People

Contributors

dmitrygvl 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.