72 lines
1.3 KiB
Markdown
72 lines
1.3 KiB
Markdown
|
# CMC Django Project
|
||
|
|
|
||
|
|
This is a Django-based web application designed to replace the old CakePHP 1.2 version of cmc-sales.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- [Feature 1]
|
||
|
|
- [Feature 2]
|
||
|
|
- [Feature 3]
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
- Python 3.x
|
||
|
|
- Django 4.x
|
||
|
|
- [Other dependencies]
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
1. Clone the repository:
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/yourusername/cmc-django.git
|
||
|
|
cd cmc-django
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Create and activate a virtual environment:
|
||
|
|
```bash
|
||
|
|
python3 -m venv venv
|
||
|
|
source venv/bin/activate
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Install dependencies:
|
||
|
|
```bash
|
||
|
|
pip install -r requirements.txt
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Apply migrations:
|
||
|
|
```bash
|
||
|
|
python manage.py migrate
|
||
|
|
```
|
||
|
|
|
||
|
|
5. Run the development server:
|
||
|
|
```bash
|
||
|
|
python manage.py runserver
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
- Access the application at `http://127.0.0.1:8000/` in your web browser.
|
||
|
|
- [Add any additional usage instructions here.]
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
Run the test suite with:
|
||
|
|
```bash
|
||
|
|
python manage.py test
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! Please follow these steps:
|
||
|
|
|
||
|
|
1. Fork the repository.
|
||
|
|
2. Create a new branch for your feature or bugfix.
|
||
|
|
3. Submit a pull request.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the [License Name]. See the `LICENSE` file for details.
|
||
|
|
|
||
|
|
## Contact
|
||
|
|
|
||
|
|
For questions or support, please contact [Your Name] at [Your Email].
|