Groupomania

Technologies

Back-end

Front-end

Cloud

About the project

Groupomania is a social network for employees of the Groupomania company. It allows employees to share their thoughts and opinions with each other.

The project is for the last project of the web developer training at OpenClassrooms.

We have to respect the following criteria in the PDF file: PDF here

Installation

Back-end

1. Clone the repository
2. Install the dependencies (from /backend folder)

npm install

3. Create a .env file in the root directory and add the following variables: (There is an example in the .env.example file)

JWT_SECRET=YOUR_SECRET
JWT_DURING=24h(24h for example)

BCRYPT_SALT_ROUND=10(10 is the default value)

IMAGES_DIR=../..
IMAGES_FOLDER=images

#For the database in dev mode
DB_USERNAME=YOUR_USERNAME
DB_PASSWORD=YOUR_PASSWORD
DB_DATABASE=groupomania_dev
DB_HOST=127.0.0.1

#For the database in prod
DB_USERNAME_PROD=YOUR_USERNAME
DB_PASSWORD_PROD=YOUR_PASSWORD
DB_DATABASE_PROD=groupomania_prod
DB_HOST_PROD=127.0.0.1

4. Create a database in PostgreSQL
5. Run the migrations

sequelize db:migrate

6. Run the seeders

sequelize db:seed:all

7. Run the server

npm run dev

Front-end

1. Clone the repository
2. Install the dependencies (from /frontend folder)

yarn install

3. Create a .env file in the root directory and add the following variables: (There is an example in the .env.example file)

VITE_API_URL=http://localhost:3000
VITE_IMAGE_URL=http://localhost:3000/images/

4. Run the server

yarn dev

Usage

Back-end

A database in postgresql is required. A free example is host on Digital Ocean with the following credentials:

Host:XX
Port:XX
Username:XX
Password:XX
Database:XX

You can know use the front end to test the application. Or you can use Postman to test the API.

Front-end

You can login in admin with the following credentials:

Email: XX@XX.XX
Password: XX

or demo user :

Email: XX
Password: XX

For the other users, you can create your own account on URL/signup

Feel free to test the application and give me your feedback. I will be happy to read it.

With the time I wish add messages between users but the time in my training is over the 27 Dec.

License

Distributed under the MIT License

Author

Created by @Commantary