Dmtrap

🎉 Eventives-BE - Easy Event Management API Setup

🚀 Getting Started

Welcome to the Eventives-BE repository! This software provides a backend API designed for event management, built using NestJS and PostgreSQL. It’s simple to set up and integrates seamlessly with a Next.js front end.

📥 Download Eventives-BE

You can download the latest version of Eventives-BE from our Releases page. This is where you will find all the files you need to get started.

Visit this page to download: Eventives-BE Releases

🛠️ System Requirements

Before you start, ensure your system meets the following requirements:

• Operating System: Windows, macOS, or Linux.
• Docker: You will need Docker installed to run the application. Download it from the Docker website.
• PostgreSQL: This application relies on a PostgreSQL database. You can download it from PostgreSQL downloads.

📂 Installation Steps

1. Download the Software
   • Go to the Eventives-BE Releases page.
   • Look for the latest version.
   • Download the corresponding files for your operating system.
2. Set Up Docker
   • Install Docker if you haven’t already. Follow the instructions on the Docker website.
   • Once installed, open Docker to ensure it’s running.
3. Run the Application
   • Open your command line interface (Terminal, Command Prompt, or PowerShell).
   • Navigate to the directory where you downloaded the Eventives-BE files.
   • Use the following command to build and run the application:

     docker-compose up
     

   • This command will start the application and the PostgreSQL database.
4. Access the API
   • After the application starts, you can access the API through your web browser.
   • Visit: http://localhost:3000/api-docs to explore the API.
   • Use the Swagger UI for an interactive experience.

🌟 Features

• User Management: Create and manage user accounts effortlessly.
• Event Scheduling: Easily set up, manage, and track events.
• Email Notifications: Stay updated with mailer integration.
• API Access: Access all features via a well-documented API.
• OpenAPI Documentation: Explore the API using Swagger UI.

🔧 Troubleshooting

If you encounter issues during installation or running the application, consider the following tips:

• Docker Not Starting: Make sure Docker is running and configured correctly. Restart your computer if needed.
• Permission Errors: Run your command line as an administrator or ensure you have sufficient permissions.
• Database Connection Issues: Confirm that PostgreSQL is installed and running. Check the connection settings in the Docker configuration file.

📚 Additional Resources

• Docker Documentation: For help with Docker: Docker Docs
• PostgreSQL Documentation: For help with PostgreSQL: PostgreSQL Docs

Thank you for choosing Eventives-BE for your event management needs! If you have any questions or need further assistance, please feel free to open an issue on GitHub.