Code Monkey home page Code Monkey logo

gigih-social-media-backend's Introduction

gigih-social-media-backend

Generasi Gigih Social Media Backend Project

alt text

Introduction

Developing a social media application which can be used to share information with other people. This application will only be used by people that work in a certain company so we cannot use existing public social media. Using Sinatra

Project Scope

SPEC.MD

Installation Run without Docker

  1. Fork and clone repo to your local machine
  2. Use bundle install to install dependencies or Use bundle install --path vendor/bundle
  3. Create .env file based on .env.example
  4. source .env file
  5. Create folder public/files run mkdir public and mkdir files inside public
  6. Run with ruby main.rb or rackup -p 4567

Running Linter

rubocop -a or rubocop --auto-correct-all

Commit Guidelines

There are 4 commit type :

  1. [TEST] : This shows test commit
  2. [FEATURE] : This shows feature is developed first rather than test first
  3. [DEPENDENCIES] : This shows adding dependencies such as Collection , Schema or etc..
  4. [HELPERS] : This shows helper class is developed

Run Unit Testing

  1. run rspec -f d should run all test

Installation run with Docker Single Container

  1. run sh ./lib/setup.sh
  2. run docker ps to make sure your app running locally
  3. run docker exec -it YOURCONTAINERID bash
  4. Create folder public/files mkdir public and mkdir files inside public
  5. Access your app through localhost:4567/

Installation run with Docker Single Container with MySql

  1. run docker-compose run app sinatra new . --force --database=mysql --skip-bundle
  2. run sh ./lib/mysql-docker.sh
  3. run docker-compose build
  4. run docker-compose up
  5. run docker exec -it YOUCONTAINERID bash
  6. Create folder public/files mkdir public and mkdir files inside public
  7. access your app through localhost:4567/

Schema Design

alt text

API Documentation

For this project, Postman Collection was used to test the API Endpoint

  • Go check this link here !
  • Go check this link for JSON export here !

Production URL

You can access here the production on Production Link

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.