Ziprus is a comprehensive project that serves as a company website and includes an admin dashboard for managing orders and contact form submissions. This README provides an overview of the project, its features, and instructions for installation and usage.
- Company Website: Showcase your company's products, services, and information to visitors.
- Admin Dashboard: Secure login for authorized members to manage orders and contact form submissions.
- Order Management: View, edit, and update orders received through the website.
- Contact List Management: Access and manage the list of contacts submitted via the contact form.
- Authentication: Only authorized members can access the admin dashboard and sensitive data.
-
- Database: to store the orders placed and the contact form submitted.
To get started with Zprus on your local machine, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/Zprus.git
-
Install dependencies:
npm install
-
Configure environment variables:
- Rename
.env.example
to.env
. - Update the
.env
file with your environment-specific variables, such as database credentials and authentication settings.
- Rename
-
Run the application:
npm start
-
Access the application:
- Open your web browser and navigate to
http://localhost:3000
to view the company website. - To access the admin dashboard, go to
http://localhost:3000/admin
and log in with your credentials. - To access the admin e-training, go to
http://localhost:3000/e-learning
and log in with your credentials.
- Open your web browser and navigate to
Once the application is running, here's how you can use it:
- Company Website: Explore the website to learn about your company's offerings and services.
- Admin Dashboard: Log in to the admin dashboard to manage orders and contact form submissions.
- View orders: See a list of orders received and their details.
- Manage contacts: Access and update the contact list filled by users.
Contributions to Zprus are welcome! If you'd like to contribute to the project, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature-name
). - Make your changes.
- Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature/your-feature-name
). - Create a new Pull Request.
This project is licensed under the MIT License.
For any inquiries or support, please contact letsconnect@collinsabu.tech you can also view this project on : ziprus.collinsabu.tech