Snapcheck is a background verification app built using Next.js, Shad CN UI, Tailwind CSS, MongoDB, and TypeScript (.tsx). This application streamlines the process of verifying backgrounds with a sleek and responsive user interface.
- Responsive and intuitive UI built with Shad CN UI and Tailwind CSS
- Background verification functionalities
- Integration with MongoDB for data storage
- Developed with Next.js and TypeScript for a robust and scalable application
Before you begin, ensure you have the following prerequisites installed on your system:
Follow these steps to set up and run Snapcheck on your local machine:
-
Clone the repository:
git clone https://github.com/agilelabsgit/snapcheck.git
-
Navigate to the project directory:
cd snapcheck
-
Install the dependencies:
Using npm:
npm install
-
Create a
.env.local
file in the root of the project and add your MongoDB connection string and any other necessary environment variables:MONGODB_URI="" TOKEN_SECRET="" EMAIL_USERNAME="" EMAIL_PASSWORD="" DOMAIN=http://localhost:3000
-
Run the development server:
Using npm:
npm run dev
-
Open your browser and visit http://localhost:3000 to see the application running.
Once the application is running, you can navigate through the various sections to perform background verification tasks. The UI is designed to be intuitive and user-friendly.
Contributions are welcome! If you would like to contribute to Snapcheck, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Add some feature'
- Push to the branch:
git push origin feature/your-feature-name
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.