aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: b373d9686a5e80932d7b4ac3eff06890713dbc28 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Alphabet Learning Online

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.