aboutsummaryrefslogblamecommitdiffstats
path: root/README.md
blob: cdf97005c9407bf8c1c39dbbb8d99805edcb0cdd (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
                          
 



                                                                                                                                                                                                                                                                                                                              
               



                               











                                                       

                                                                                          






























































                                                                                                                                                                                                                           




                                                                                                                       

                                             
 
# 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)
- [Site](#site)
- [Technologies](#technologies)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [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

## Site
The live site 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.

## 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:
- GitHub: [yulqen](https://github.com/yulqen)