Table of Contents
Email-Verify is a full-stack application that facilitates email verification using Gmail SMTP for sending emails. It is built with Express.js and Prisma on the backend, utilizing a PostgreSQL database. On the frontend, React and Tailwind is used to create a user-friendly interface for entering and checking verification codes.
Lets get to the instructions on setting up both the client and server locally. To get a local copy of both up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- clone the project
git clone https://github.com/johnhaab/email-verify.git
- Open the client folder
cd client
- Install NPM packages
npm install
- Start the client
npm run dev
- Open the server folder
cd server
- Install NPM packages
npm install
- Create a .env file
- Windows
echo .env
- Linux/MacOS
touch .env
- Paste the following info into the .env
DATABASE_URL=" YOUR POSTGRES URL " SMTP_GMAIL=" THE GMAIL EMAIL YOU ARE USING " SMTP_GMAIL_PASS=" CREATE A GMAIL APP SPICIFIC PASSWORD FOR THIS "
- Create a Gmail App Spicific Password: https://myaccount.google.com/apppasswords
- To get Prisma ready run these commands
npx prisma migrate init && npx prisma generate
- To get Prisma ready run these commands
npx prisma migrate init && npx prisma generate
- Start the server
npm run start
- There might be issues if your hosting your server on a different ip than the client. - Not confirmed.
- Create a better security system for anti-spam etc
- Add additional Email Templates
- Create the resend function
- Multi-language support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
John Haab - @johnlhaab - contactjohnhaab@gmail.com
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!