The Odin-Book "b-sociale"

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is made as the Final project in the node.js path for The Odin Project curriculum . It's a facebook clone with a lot of the main site features like:

• Authentication
• CRUD functionalities on Posts, Users.
• Handeling friend requests & friend requests responses & unfriending

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/krimoelbahri/theOdinBook.git

2. Install NPM packages

   npm install

3. Install NPM packages inside the frontend folder

   cd frontend
   npm install

4. Make a .env file based on the .env.example

5. Run the app

   npm run dev

(back to top)

Roadmap

• Add live chat feature
• Make live updates between users
• Handeling queries state all around the app

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Karim Guezlane - [email protected]

Project Link: https://github.com/krimoelbahri/theOdinBook

(back to top)

Acknowledgments

• Font Awesome
• Mantine
• [Best-README-Template] (https://github.com/othneildrew/Best-README-Template)

(back to top)