Review-companies-platform(charika)

Review-companies-palatform:

Charika is a platform where job searchers can find reviews about thear interested companies to join, they can find reviews, suggestions, and they can also make reviews , view comments and make comments on reviews of people to ask them question related to this company, this review platform enable transparency and give full info about companies and their quality

User Stories:

• As a visitor I can see the home page and view some reviews about companies
• As a user I can register in order to have an account on the platform
• As a user I have to verify my Email before login to the platform
• As a user I can log in to see all the reviews about Companies
• As a user I can search by company name,filter by category,location,or the most having good reviews
• As a user I can view reviews about a company
• As a user I can comment on reviews
• As a user I can edit my account
• As a user I can delete my account
• As a user I can logout
• As a user I can reset my password
• As a user I can follow a company to have notifications
• As a manager i can login
• As a manager i can logout
• As a manager i can add companies edit delete
• As a manager i can view and delete reviews of my companies
• As an admin i can have the same roles of manager
• As an admin i can add manager,edit,delete

Technologies:

• Html Css Bootstrap
• javascript vue js
• mysql php laravel Rest api jwt

Outils of Dev:

• Xampp : database
• Postman : test api
• Figma : prototype => you will find the prototype folder in this repo Click here
• Chrome : lunch website

Outils of Planification:

• Jira : planification of the project link public click here it can be an error in access will be fixed soon

Conception:

• Diagramms.net UML : click here

project structure:

Laravel Backend Repo : https://github.com/Karim-elaoumari/Review-companies-platform.git

Vue js frontend Repo : https://github.com/Karim-elaoumari/charika_platform.git

this separation is due to hosting method i what to implement using Heroku CLI and it's more safe to separate backend with frontend.

Steps to clone the project and Lunch it:

• 1) clone the backend and frontend Repo
• 2) Aceess the laravel Repo lunck the Terminal and run this commands:
• - composer install
• - npm install
• - cp .env.example .env
• - php artisan key:generate
• - php artisan jwt:secret
• - php artisan migrate create the database
• - php artisan db:seed to create a testing data
• - php artisan serve to run the server in the http://localhost:8000
• 3) Aceess the Vue js Repo lunck the Terminal and run this commands:
• - npm install
• - npm run dev to run the server in the http://localhost:3000
• now you can Explore the Platform

Note that the Platform Still on the Dev Mode mybe Errors be there !