aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Lemon <y@yulqen.org>2024-12-30 21:38:47 +0000
committerMatthew Lemon <y@yulqen.org>2024-12-30 21:38:47 +0000
commitacf0a5397b0d3c1a75632a31daf568b2772e5856 (patch)
treeecc968aeab77126f9be1630f14399ac6a25f8b12
parent5b62ccbc106781751872475fb49a320a77281f8d (diff)
Updates the README
-rw-r--r--README.md108
1 files changed, 106 insertions, 2 deletions
diff --git a/README.md b/README.md
index a0c5e03..b373d96 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,107 @@
-## Alphabet Learning Online
+# Alphabet Learning Online
-The sourcecode.
+Welcome to the **Alphabet Learning Online** project! This is a Django-based e-commerce platform dedicated to providing educational resources for learners of all ages. Our objective is to create a user-friendly marketplace where educators, parents, and students can easily find and purchase valuable learning materials.
+
+## Table of Contents
+- [Features](#features)
+- [Demo](#demo)
+- [Technologies](#technologies)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Features
+- User registration and authentication
+- Product catalog with categories and filtering options
+- Shopping cart functionality
+- Secure payment processing
+- Order management for both users and administrators
+- User reviews and ratings for products
+- Responsive design for mobile and desktop users
+
+## Demo
+A live demo of the project can be found at: [alphabetlearning.online](https://alphabetlearning.online).
+
+## Technologies
+This project is built using:
+- **Django** - A high-level Python web framework
+- **SQLite / PostgreSQL** - For database management
+- **Bootstrap** - For responsive front-end design
+- **Stripe** - For payment processing
+
+## Requirements
+Before you start, ensure you have the following installed:
+- Python 3.8 or higher
+- pip (Python package installer)
+
+## Installation
+To set up the project locally, follow these steps:
+
+1. **Clone the repository:**
+ ```bash
+ git clone https://github.com/yulqen/alphabetlearning.git
+ cd alphabetlearning
+ ```
+
+2. **Create a virtual environment:**
+ ```bash
+ python -m venv env
+ ```
+
+3. **Activate the virtual environment:**
+ - On Windows:
+ ```bash
+ .\env\Scripts\activate
+ ```
+ - On macOS/Linux:
+ ```bash
+ source env/bin/activate
+ ```
+
+4. **Install the required packages:**
+ ```bash
+ pip install -r requirements.txt
+ ```
+
+5. **Set up the database:**
+ ```bash
+ python manage.py migrate
+ ```
+
+6. **Create a superuser for the admin panel:**
+ ```bash
+ python manage.py createsuperuser
+ ```
+
+7. **Run the server:**
+ ```bash
+ python manage.py runserver
+ ```
+
+8. **Visit the application:**
+ Go to `http://127.0.0.1:8000` in your web browser.
+
+## Usage
+Once set up, you can browse the platform, register as a user, and start exploring the educational resources. Admin users can access the admin panel at `http://127.0.0.1:8000/admin` to manage products, orders, and users.
+
+## Contributing
+We welcome contributions to improve the Alphabet Learning Online platform! Please follow these steps to contribute:
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Ensure your changes are covered by tests.
+4. Submit a pull request detailing your changes.
+
+## License
+This project is licensed under the GNU Affero General Public License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+For inquiries or feedback, please reach out to:
+- Email: support@alphabetlearning.online
+- GitHub: [yulqen](https://github.com/yulqen)
+
+---
+
+Thank you for your interest in Alphabet Learning Online! We hope you enjoy using and contributing to our platform.