isaaclopinho / socially Goto Github PK

Socially

A social network app!
Explore the docs »

View Demo · Report Bug · Request Feature

A social network where you can connect with other people and exchange the most diverse experiences, share knowledge, or even how your day was!

(back to top)

In this section all the main frameworks/libraries used for the development of this project are presented.

• React.js
• Styled Components
• Axios
• Web Vitals
• Socket.IO

(back to top)

In this section you will know all the steps so that you can make a quick and practical installation of the project. Follow the steps that have been listed below sequentially and enjoy the work!

Before starting the project installation, it is essential that some prerequisites are met, and each of them are listed below.

• npm

  npm install npm@latest -g

• postgres

  sudo apt install postgresql postgresql-contrib

Also, don't forget to visit this project's api repository, as it will be essential to be able to execute locally on your machine.

Follow the steps listed below to correctly install and configure the application in a simple and practical way. If there is an error in the installation or if any of the steps listed below is not done, you are not sure that the project will work on your machine, follow the steps, if you have any questions about this step, contact us.

1. Clone the repo

   git clone [email protected]:ruineto-dev/socially.git

2. Install NPM packages

   npm install

3. Enter your BASE URL in .env

   REACT_APP_API_BASE_URL=http://localhost:5000

   (back to top)

To start using the project, just follow the steps that were presented along the Roadmap, listed below. Soon some photos/images/videos of usability examples of the project will be posted here.

(back to top)

• Clone the project
• Open the project with an IDE/code editor
• Install project dependencies
• Create a new branch with your new feature
  • Access the new feature
  • Push the new modifications
• Add a pull request
• Wait for the evaluation (around 1 day) See the open issues for a full list of proposed features (and known issues).

(back to top)

Every contribution is always welcome from all developers. Contributing and sharing knowledge is what makes the world a diverse and exciting place, so if you have a suggestion, please share it. If you want to share a suggestion, fork the repository and create a pull request. If you feel comfortable, open an issue with the tag "enhancement". Help spread the word about this incredible work by giving the project a star! Thanks again!

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

(back to top)

Distributed under a FREE license. Consult the developer for more information.

(back to top)

Rui Neto - @ruineto-dev - [email protected]
Project Link: @socially

(back to top)

I would like to express my sincere thanks to my teacher Mateus De Nardo, because everything I managed to develop was the result of a long and very difficult journey, where I was accompanied by him. And I could not fail to mention it in this authorial project, where it is without a doubt one of my best projects.

Regarding the design of the project, I would also like to thank the team at @pixeltrue that made this project possible by making the design of the project presented here available on the internet for free for free use (if you wanted to visit the page where the design of the project taken as a basis, Social Media App Design).

And on the technical side, I thank the team that developed the web socket tool, Socket.IO, which is simply the reason why it is possible to carry out conversations in real time in a chat, thank you very much!

And as an honorable mention, I would also like to thank the technologies listed below.

• Cypress
• ESlint
• Prettier

(back to top)