Xf-Registration is a comprehensive user registration and management system designed to streamline the onboarding process and enhance user interaction. This project offers a robust set of features for user registration, profile management, and user discovery.
-
User Registration with Email Notification
- Automated email confirmation upon successful registration
Subject: 'Xf Registration Successfully Completed 🦾' Message: 'Thank you for registering with Xf. You can now explore the platform.' -
Advanced User Search
- Find users based on skills, username, postal code, or college name
- Proximity-based search using radius, latitude, and longitude
-
Profile Management
- Update phone number and username
- Upload and manage profile photo and background image
- Secure image storage using multer package
-
Account Actions
- User registration
- Profile updates
- Account deletion
-
OAuth Integration
- Seamless authentication with GitHub
For detailed API documentation, please visit our Postman Documentation.
Ensure you have Node.js and npm installed on your system.
-
Clone the repository:
git clone https://github.com/manzil-infinity180/Xf-Registration_frontend.git cd Xf-Registration_frontend -
Install dependencies:
npm install express nodemailer nodemon passport passport-github validate validator express-session jsonwebtoken mongodb mongoose multer passport-google-oauth crypto-js -
Configure environment variables:
- Create a
config.envfile in the root directory - Add necessary environment variables (refer to
config_example)
- Create a
-
Start the application:
npm start
We welcome contributions to the Xf-Registration project. Please feel free to submit issues, fork the repository and send pull requests!
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Thanks to all contributors who have helped shape Xf-Registration
- Special thanks to the open-source community for the fantastic tools and libraries used in this project