Socio is a simple social media application built using React, Redux, and Node.js. The application allows users to create an account, log in, and post messages that can be seen by other users.
You can install Socio by following these steps:
- Clone the repository:
git clone https://github.com/gurdeepsingh-hub/socio.git
- Move into the project directory:
cd socio
- Install the dependencies:
npm install
- Create a
.env
file in the root of the project and add the following:REACT_APP_API_URL=http://localhost:5000/api
- Start the server:
npm start
The application will be accessible at http://localhost:3000.
Socio is built using React and Redux for the frontend, and Node.js and Express for the backend. The frontend and backend are served separately.
The frontend can be built for production using the following command:
npm run build
The built files will be available in the build
directory.
The backend code for Socio is hosted in a separate repository. You can find the backend code and related documentation at the following link:
Feel free to explore the backend repository for more details on the API endpoints, database schemas, and implementation details.
If you've cloned this repository and plan to use OAuth authentication with Google, you'll need to add the oauth_config.json
file with your own OAuth credentials. Follow these instructions to update the file:
-
create the
oauth_config.json
file in the root directory of the project. -
Replace the existing values with your own OAuth credentials obtained from the Google Developer Console.
-
Save the changes to the file.
Once you've created the oauth_config.json
file with your credentials, you'll be able to use OAuth authentication with Google in your application. Make sure to keep your credentials secure and never expose them publicly.
Socio uses Jest for unit testing and Cypress for end-to-end testing.
To run the unit tests:
npm test
To run the end-to-end tests:
npm run cypress:open
We welcome contributions to Socio! If you have an idea for a new feature or have found a bug, please open an issue. If you have a fix or improvement, please submit a pull request.
Socio is released under the MIT License.
For any questions or concerns, please contact us at [email protected].
Gurdeep Singh (gurdeepsingh-hub)