Register App is a web application designed to simplify event management and attendance tracking. It enables users to authenticate securely using their phone numbers, manage their own and their additional guests' attendance status, and specify dietary requirements or preferences.
- Passwordless authentication via SMS.
- Secure session management.
- User-friendly interface for displaying event information and allowing users to register themselves and their additional guests for the event.
- Next.js
- React
- Node.js
- TypeScript
- Material UI
- MongoDB
- Twilio Verify API
- GitHub
- Vercel
- ESLint
- Prettier
For detailed security information, refer to the Security.md file in the root folder.
Follow these steps to set up and run the application locally.
Ensure you have the following installed on your system:
- Clone the repository:
git clone https://github.com/Zantemann/register_app cd register_app- Install dependecies:
npm install- Set up environment variables:
- Copy the .env.example file to .env.local:
cp .env.example .env.local- Update the
.env.localfile with your Twilio API keys and MongoDB connection string.
Start the development server:
npm run devOpen http://localhost:3000 in your browser to view the application.
To deploy the application, use the Vercel Platform. Follow these steps:
- Push your code to a GitHub repository.
- Connect your repository to Vercel.
- Configure environment variables in the Vercel dashboard.
- Deploy your application.
For more details, refer to the Next.js deployment documentation.
To learn more about the technologies used in this project, check out the following resources:
- Next.js Documentation - Learn about Next.js features and API.
- Twilio Verify API Documentation - Learn about Twilio's passwordless authentication.
- MongoDB Documentation - Learn about MongoDB for data storage.