Giter Club home page Giter Club logo

mt2022_proj01_wiki's Introduction

Description

This is a school project. The requirements are to create a restfull api, using Go, to manage some articles with comments. We must use JWT for the authentication, MVC pattern for the architecture, and GORM with MySQL for the database.

A complete documentation with a clean repository is mandatory.

Developers

  • Corentin Croizat
  • Christophe Charlebois
  • Clément Haller
  • Guillaume Cornet

Table of Contents

Directory Structure

<Wiki-Go>/
├─ api/
|   └─ server/
|       └─ routes.go
|       └─ server.go
├─ controllers/
├─ documentation/
|   └─ swagger.json
├─ middleware/
├─ models/
├─ utils/
├─ view/
├─ docker-compose.yml
├─ main.go
└─ README.md

Model Structure

Alt text

Used Package

Api Documentation

Once docker-compose is up you can navigate to http://localhost:8085/documentation/api/v1/

Api server

http://localhost:8080

Installation

  • Launch MySQL, phpmyadmin, swagger, and api
docker-compose up --build

Wait for the mysql container to mount

if the server is not up when the mysql container has finished mounting, run the docker-compose up command again

mt2022_proj01_wiki's People

Contributors

mosieurclement avatar telmalk avatar corentincrz avatar vinicel avatar panathes avatar

Watchers

 avatar

mt2022_proj01_wiki's Issues

Article > Crud article

add the following options:

  • Create an article
  • Read an article
  • Update an article
  • Delete an article

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.