Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Groupe 2 - Projet SkillFusion

imagesource by Roselyn Tirado

Welcome to our vibrant online DIY lesson platform project made by students !

Here, you'll discover a virtual space dedicated to mastering the art of DIY and construction. From woodworking to interior design to electronic repairs, our diverse range of online lessons has something for everyone.

Whether you're just starting out or a seasoned DIY enthusiast, our platform empowers you to unlock your potential, hone your skills, and bring your projects to life with boundless enthusiasm !

Contributors

Static Badge

Static Badge

Static Badge

Static Badge

Project status:

Static Badge Static Badge

Project dependencies :

Client

Static Badge Static Badge

dev dependency : Static Badge

Server

Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge

dev dependency : Static Badge

REST API Documentation

You must have node and postgres installed on your server

Installation

npm install

Server configuration

You can configure the accessible port of your server as well as the connection information to your database given in the .env.example file.

Run in dev environment

npm run dev

Run in production environment

npm run start

Users routes

Get user by id

Request :

GET /users/:user_id

example: http://[server_url]/users/1

Response :

200 OK 
{
    "status": "succes",
    "message": "Data of user sent",
    "datas": {
        "id": 1,
        "role": "member",
        "username": "member",
        "email": "member@test.fr"
    }
}
Get all users

Request :

GET /users

example: http://[server_url]/users

Response :

200 OK
{
    "status": "succes",
    "message": "Data of users sent",
    "datas": [
        {
            "id": 1,
            "role": "member",
            "username": "member",
            "email": "member@test.fr"
        },
        {
            "id": 2,
            "role": "member",
            "username": "member2",
            "email": "member2@test.fr"
        },
        {
            "id": 3,
            "role": "member",
            "username": "member3",
            "email": "member3@test.fr"
        }
    ]
}
Create new user

Request :

POST /users/register

Response :

200 OK
{
    "status": "succes",
    "message": "Created user"
}
Login

Request :

POST /users/login

Response :

201 CREATED
{
    "status": "success",
    "token": "83bb496c997840bd90e053bc360701b3d852c1808dfeeb2ccf90be243440fdb2",
    "tokenExpires": "2024-02-11T17:18:57.561Z"
}
Update user

Request :

PATCH /users

Response :

200 OK
{
    "status": "success",
    "message": "Updated user"
}
Delete user

Request :

DELETE /users/:user_id

Response :

200 OK
{
    "status": "success",
    "message": "Deleted user"
}
Logout

Request :

PATCH /users/logout

Response :

200 OK
{
    "status": "success",
    "message": "Deleted token"
}

Lessons routes

Get lesson by id

Request :

GET /lessons/:lesson_id`

example:http://[server_url]/lessons/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of lesson sent',
}
Get all lesson

Request :

GET /lessons`

example:http://[server_url]/lessons

Reponse :

200 OK
{
status:'succes',
message: 'Data of lessons sent',
}
Create new lesson

Request :

POST /lessons/

    example:http://[server_url]/lessons/

Response :

200 OK
{
    "status": "succes",
    "message": "Created lesson"
}
Update lesson

Request :

PATCH /lessons/:lessons_id/:user_id

example:http://[server_url]/lessons/1/12

Response :

200 OK
{
    "status": "success",
    "message": "Updated lesson"
}
Delete lesson

Request :

DELETE /lessons/:lessons_id/:user_id

example:http://[server_url]/lessons/1/12

Response :

200 OK
{
    "status": "success",
    "message": "Deleted lesson"
}

Categories routes

Get category by id

Request :

GET /categories/:category_id`

example:http://[server_url]/categories/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of category sent',
}
Get all categories

Request :

GET /categories/`

example:http://[server_url]/categories/

Reponse :

200 OK
{
status:'succes',
message: 'Data of categories sent',
}
Create new categories

Request :

POST /categories/

example:http://[server_url]/categories/

Response :

200 OK
{
    "status": "succes",
    "message": "Created categories"
}

Steps routes

Get step by id

Request :

GET /steps/:step_id`

example:http://[server_url]/steps/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of step sent',
}
Get all step

Request :

GET /steps`

example:http://[server_url]/steps

Reponse :

200 OK
{
status:'succes',
message: 'Data of steps sent',
}
Create new step

Request :

POST /steps/

    example:http://[server_url]/steps/

Response :

200 OK
{
    "status": "succes",
    "message": "Created step"
}
Update step

Request :

PATCH /steps/:step_id

example:http://[server_url]/steps/1

Response :

200 OK
{
    "status": "success",
    "message": "Updated steps"
}
Delete step

Request :

DELETE /stepss/:steps_id

example:http://[server_url]/steps/1

Response :

200 OK
{
    "status": "success",
    "message": "Deleted step"
}

Rates routes

Get rates by id

Request :

GET /rates/:rate_id`

example:http://[server_url]/rates/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of rate sent',
}
Get all rates

Request :

GET /rates/`

example:http://[server_url]/rates/

Reponse :

200 OK
{
status:'succes',
message: 'Data of rates sent',
}
Create new rate

Request :

POST /rates/:lesson_id/:user_id

example:http://[server_url]/rates/1/10

Response :

200 OK
{
    "status": "succes",
    "message": "added rate"
}

Likes routes

Get likes by id

Request :

GET /likes/:like_id`

example:http://[server_url]/likes/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of like sent',
}
Get all likes

Request :

GET /likes/`

example:http://[server_url]/likes/

Reponse :

200 OK
{
status:'succes',
message: 'Data of likes sent',
}
Create new like

Request :

POST /likes/:comment_id

example:http://[server_url]/likes/1

Response :

200 OK
{
    "status": "succes",
    "message": "added like"
}

Comments routes

Get comment by id

Request :

GET /comments/:comment_id`

example:http://[server_url]/comments/1

Reponse :

200 OK
{
'status': 'succes',
'message': 'Data of comment sent',
}
Get all comments

Request :

GET /comments`

example:http://[server_url]/comments/

Reponse :

200 OK
{
status:'succes',
message: 'Data of comments sent',
}
Create new comment

Request :

POST /comments/

    example:http://[server_url]/comments/

Response :

200 OK
{
    "status": "succes",
    "message": "Created comment"
}
Update comment

Request :

PATCH /comments/:comments_id

example:http://[server_url]/comments/1

Response :

200 OK
{
    "status": "success",
    "message": "Updated comment"
}
Delete comment

Request :

DELETE /comments/:commentToDelete_id/:userWhoDelete_id

example:http://[server_url]/comments/1/12

Response :

200 OK
{
    "status": "success",
    "message": "Deleted comment"
}

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages