✨ Your all-in-one solution for simplifying small business payments.

Live Demo 🚀

---

📜 About

Aurora is your go-to application, designed to simplify small business payments. It provides a seamless platform for business owners to manage invoices, track payments, and streamline their financial processes.

⚙️ Features

• Business Profile Setup
• Customer Management
• Real-time Analytics on the Dashboard
• Invoice Creation and Management
• Prevention of Duplicate Payments
• Automated Payment Reminders
• User Feedback Mechanisms
• Enhanced User Interface

🛠 Tech Stack

• Full Stack Framework: Next.js
• Database: MongoDB (w/ Prisma)
• Authentication: NextAuth
• Styling: Tailwind CSS
• Programming Language: TypeScript

🚩 Prerequisites

Ensure that your system meets the following requirements:

• Node.js version >= 18.18.0
• npm version >= 9.8.1

⚡ Installation

Before proceeding, make sure your system satisfies the prerequisites mentioned above.

Firstly, clone the Aurora repository into your desired folder and navigate into it:

$ git clone https://github.com/omzi/aurora-v0 && cd aurora

Install the project dependencies using npm (or yarn if you prefer):

npm i

⚙ Environment Variables

Aurora requires certain environment variables to be set to function properly. Create a .env file in the root of your project and add the following variables:

NODE_ENV = # Your current environment
NEXTAUTH_SECRET = # Your NextAuth secret
NEXTAUTH_URL = # Eg: http://localhost:3000

EDGE_STORE_ACCESS_KEY = # Your EdgeStore access key
EDGE_STORE_SECRET_KEY = # Your EdgeStore secret key
BREVO_API_KEY = # Your Brevo API key

DATABASE_URL = # Your Database URL

PAYSTACK_TEST_PK = # Your Paystack test public key
PAYSTACK_TEST_SK = # Your Paystack test secret key

Explanation of the environment variables:

• NODE_ENV: Set it to development for local development.
• NEXTAUTH_SECRET: To generate a secret key for NextAuth, enter your terminal (or Git Bash) & type the following:

openssl rand -base64 32

Set the value of NEXTAUTH_SECRET to the result.

• NEXTAUTH_URL: Set it to the URL where your Aurora application is hosted during development. For external services:
• EDGE_STORE_ACCESS_KEY and EDGE_STORE_SECRET_KEY: These are access and secret keys for your EdgeStore (for handling file uploads) service.
• BREVO_API_KEY: This is the API key for the Brevo (a transactional email provider) service.
• DATABASE_URL: Set it to the connection string of your MongoDB cluster.
• PAYSTACK_TEST_PK: Your Paystack (for payments) test public key. If you don't a Paystack account, you'll have to create one.
• PAYSTACK_TEST_SK: Your Paystack test secret key.

Once the environment variables are set, you can run Aurora locally with:

npm run dev

Visit the URL http://localhost:3000/ in your browser to access the Aurora application.

👥 Contributors

• Omezibe Obioha (@0xOmzi)
• Tito Onwudinjo (@titoonw)
• Emmanuel Adisa (@emmie_porsche)
• Adebanjo Mary (@Ademarymi)

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

❌ Disclaimer

This project is a submission to the Klusterthon 2023 organized by Stutern. It is NOT yet production-ready!

---

Back To Top ↺

Made with ♥