ProjectSyncify 💻

Technologies Getting Started API Endpoints Collaborators Contribute

ProjectSyncify is a Project Management Application.

📱 Visit this Project

💻 Technologies

list of all technologies we used

• Django
• Django REST Framework
• PyJWT
• Google Auth
• SQLite

🚀 Getting started

Skip for now

Prerequisites

pip install -r requirements.txt

Run this command to install all prerequisites. Or have a look on 'requirements.txt'.

Cloning

git clone https://github.com/TechBuilderTeam/project-syncify-server.git

Run this command to clone this project.

Config .env variables

Use the .env as reference to create your configuration file .env with your Google, GitHub Credentials

EMAIL= ''
EMAIL_PASSWORD='' 
GOOGLE_CLIENT_ID={your google client id}
GOOGLE_CLIENT_SECRET={your google client secret}
GITHUB_CLIENT_ID={your github client id}
GITHUB_CLIENT_SECRET={your github client secret}
SOCIAL_AUTH_PASSWORD=''

Starting

How to start this project

python manage.py runserver

📍 API Endpoints

Here you can list the main routes of your API, and what are their expected request bodies. ​

route	description
POST /api/v1/auth/register/	Register a new user details
POST /api/v1/auth/login/	Login User request details

more endpoints comming soon...

POST /api/v1/auth/register/

POST

{
  "email": "najmulislamru@gmai.com",
  "first_name": "Najmul",
  "last_name": "Islam"
  "password":"*******"
  "password2":"*******"
}

🤝 Collaborators

Special thank you for all people that contributed for this project.

Najmul Islam

Sifat Islam

📫 Contribute

1. git clone https://github.com/TechBuilderTeam/project-syncify-server.git
2. git checkout -b feature/NAME
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern