Overview
VuePeople is a platform that lists and connects Vue.JS developers globally. It provides a space for Vue.JS enthusiasts to come together, collaborate, and contribute to the community. The platform facilitates networking and communication among Vue.JS developers worldwide, creating a supportive environment for sharing knowledge and expertise.
Features
- CircleCi Integration: Utilizes CircleCi for seamless integration and automation of development processes.
- Frontend Build Setup: Offers specific development environment configurations for setting up the frontend.
- Backend Build Setup: Provides instructions for configuring and setting up the backend development environment.
- SSL Certificates: Includes support for SSL certificates to ensure secure communication.
- License: Complies with the MIT license for open-source contribution.
- Contribution Guidelines: Clearly outlines the steps for contributing to the platform by forking, cloning, and setting up the repository.
Installation
- Fork the Repository: Begin by forking the repository to your own account.
- Clone the Repository: Clone the forked repository to your local machine.
- Frontend Setup:
cd vue-people/frontend yarn yarn dev cp .env.template .env - Modify .env File:
- Add the following lines to the
.envfile:NODE_TLS_REJECT_UNAUTHORIZED = '0'WEBSOCKET_PROTOCOL = ws- Modify the host to
host=0.0.0.0
- Add the following lines to the
- Backend Setup:
cd ../django/ cp .env.template .env - Update .env File:
- Add a random long string under SECRET_KEY in
django/.env.
- Add a random long string under SECRET_KEY in
- Docker Setup:
docker-compose build docker-compose up -d docker-compose exec django python manage.py migrate docker-compose exec django python manage.py createsuperuser - Admin Configuration:
- Generate an admin user by following the prompt during superuser creation.
- Access
localhost/adminand login with the created credentials.
- Application Setup:
- Go to Sites and add localhost as the site.
- Go to social accounts/social applications and add a social application with provider: GitHub, name: Github, ClientId: XXX, Secret Key: XXXX.
- Refer to GitHub’s guide for obtaining ClientID and Secret Key.
- Pull Request:
- Commit your changes and create a pull request from your fork to the main repository.
Summary
VuePeople is a platform designed to bring Vue.JS developers together, providing a collaborative space for sharing knowledge and connecting with like-minded professionals. With features like CircleCi integration, SSL certificate support, and clear contribution guidelines, VuePeople aims to foster a vibrant Vue.JS community. By following the installation guide, developers can easily set up the platform for development and start contributing to the Vue.JS ecosystem.