|
1 | | -# CodeStacks.com |
| 1 | +# 📚 CodeStacks |
2 | 2 |
|
3 | | -Welcome to the CodeStacks.com repository! This repository hosts premium programming books offered by CodeStacks, a platform dedicated to providing high-quality resources for developers. |
| 3 | +CodeStacks is an open-source e-books website designed to help learners and developers access, share, and read a wide variety of programming e-books and resources — all in one place. |
4 | 4 |
|
5 | | -## About CodeStacks.com |
| 5 | +🌐 **Live Demo**: [Add your deployed site link here] |
6 | 6 |
|
7 | | -CodeStacks.com is a specialized platform where you can find premium programming books covering a wide range of topics and technologies. Whether you're a beginner looking to learn the basics of programming or an experienced developer aiming to deepen your knowledge in specific areas, CodeStacks.com offers curated content to meet your needs. |
| 7 | +--- |
8 | 8 |
|
9 | | -## Repository Contents |
| 9 | +## 📖 Table of Contents |
10 | 10 |
|
11 | | -This repository contains the following: |
| 11 | +- [About](#about) |
| 12 | +- [Features](#features) |
| 13 | +- [Screenshots](#screenshots) |
| 14 | +- [Tech Stack](#tech-stack) |
| 15 | +- [Getting Started](#getting-started) |
| 16 | +- [Project Structure](#project-structure) |
| 17 | +- [Contributing](#contributing) |
| 18 | +- [License](#license) |
| 19 | +- [Contact](#contact) |
12 | 20 |
|
13 | | -- **Premium Programming Books**: High-quality eBooks covering various programming languages, frameworks, and topics relevant to developers. |
| 21 | +--- |
14 | 22 |
|
15 | | -## Project Structure |
| 23 | +## 🧠 About |
16 | 24 |
|
17 | | -The project structure includes the following main components: |
| 25 | +**CodeStacks** is a community-driven platform for discovering and reading open-source e-books focused on programming, software development, and technology. The goal is to provide an easy-to-use, centralized hub of resources for students, developers, and self-learners alike. |
18 | 26 |
|
19 | | -- **CodeStacks/**: Django project directory. |
20 | | -- **manage.py**: Django's command-line utility for administrative tasks. |
| 27 | +--- |
21 | 28 |
|
22 | | -- ## Admin panel password |
| 29 | +## 🚀 Features |
23 | 30 |
|
24 | | -To run the CodeStacks Django project locally, follow these steps: |
| 31 | +- 🔎 **Browse & Search** curated open-source programming e-books. |
| 32 | +- 🗂️ **Categories** for languages, frameworks, and technologies. |
| 33 | +- 🖥️ **Responsive Design** with a clean, user-friendly interface. |
| 34 | +- ⚡ **Powerful Search** to find books instantly. |
| 35 | +- 📤 **Contribute Easily** by adding or suggesting new e-books. |
| 36 | +- 🌓 **Dark/Light Mode** support (if enabled). |
| 37 | +- 💬 **Open Source & Community-Driven** |
25 | 38 |
|
26 | | -1. Admin Username: |
27 | | - ```bash |
28 | | - Satyam |
| 39 | +--- |
29 | 40 |
|
30 | | -1. Admin Password: |
31 | | - ```bash |
32 | | - Satyam@123 |
| 41 | +## 🖼️ Screenshots |
33 | 42 |
|
34 | | -## Running the Project |
| 43 | +<p align="center"> |
| 44 | + <img src="screenshots/homepage.png" alt="CodeStacks Homepage" width="80%"> |
| 45 | + <br> |
| 46 | + <img src="screenshots/book-view.png" alt="Book View" width="80%"> |
| 47 | +</p> |
35 | 48 |
|
36 | | -To run the CodeStacks Django project locally, follow these steps: |
| 49 | +--- |
37 | 50 |
|
38 | | -1. Navigate to the project directory: |
39 | | - ```bash |
40 | | - cd C:\Users\CodeStacks\CodeStacks |
| 51 | +## 🛠️ Tech Stack |
41 | 52 |
|
42 | | -1. Run the project from: |
43 | | - ```bash |
44 | | - cd C:\Users\CodeStacks\CodeStacks>python manage.py runserver |
| 53 | +- **Backend:** Python (Flask / Django / FastAPI) |
| 54 | +- **Frontend:** HTML, CSS, JavaScript |
| 55 | +- **Other:** PowerShell, Batch scripts for automation |
45 | 56 |
|
46 | | -### Contact: |
47 | | -- [satyampote9999@gmail.com] |
48 | | -- For primium contant |
| 57 | +--- |
49 | 58 |
|
| 59 | +## ⚙️ Getting Started |
50 | 60 |
|
| 61 | +### 1. Clone the Repository |
| 62 | + |
| 63 | +```bash |
| 64 | +git clone https://github.com/SatyamPote/CodeStacks.git |
| 65 | +cd CodeStacks |
| 66 | +``` |
| 67 | + |
| 68 | +### 2. Install Dependencies |
| 69 | + |
| 70 | +> Ensure you have Python 3.8+ installed. |
| 71 | +
|
| 72 | +```bash |
| 73 | +# Create a virtual environment |
| 74 | +python -m venv venv |
| 75 | + |
| 76 | +# Activate it |
| 77 | +source venv/bin/activate # On macOS/Linux |
| 78 | +venv\Scripts\activate # On Windows |
| 79 | + |
| 80 | +# Install Python packages |
| 81 | +pip install -r requirements.txt |
| 82 | +``` |
| 83 | + |
| 84 | +> ⚠️ For frontend dependencies (if using npm/yarn), include install steps here. |
| 85 | +
|
| 86 | +### 3. Run the Application Locally |
| 87 | + |
| 88 | +```bash |
| 89 | +python app.py |
| 90 | +``` |
| 91 | + |
| 92 | +Visit: [http://localhost:5000](http://localhost:5000) |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +## 📁 Project Structure |
| 97 | + |
| 98 | +```text |
| 99 | +CodeStacks/ |
| 100 | +├── static/ # Static assets (CSS, JS, images) |
| 101 | +├── templates/ # HTML templates |
| 102 | +├── ebooks/ # E-books & metadata |
| 103 | +├── scripts/ # PowerShell / Batch / utility scripts |
| 104 | +├── app.py # Main application file |
| 105 | +├── requirements.txt # Python dependencies |
| 106 | +└── README.md |
| 107 | +``` |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## 🤝 Contributing |
| 112 | + |
| 113 | +We welcome contributions from everyone! |
| 114 | +To contribute: |
| 115 | + |
| 116 | +```bash |
| 117 | +# Fork the repository |
| 118 | +# Create your branch: |
| 119 | +git checkout -b feature/AmazingFeature |
| 120 | + |
| 121 | +# Commit your changes: |
| 122 | +git commit -m 'Add some AmazingFeature' |
| 123 | + |
| 124 | +# Push to GitHub: |
| 125 | +git push origin feature/AmazingFeature |
| 126 | +``` |
| 127 | + |
| 128 | +Then open a **Pull Request**. |
| 129 | + |
| 130 | +> For large changes, please [open an issue](https://github.com/SatyamPote/CodeStacks/issues) first to discuss the proposed update. |
| 131 | +
|
| 132 | +--- |
| 133 | + |
| 134 | +## 📝 License |
| 135 | + |
| 136 | +Distributed under the **MIT License**. |
| 137 | +See the `LICENSE` file for full details. |
| 138 | + |
| 139 | +--- |
| 140 | + |
| 141 | +## 📬 Contact |
| 142 | + |
| 143 | +Created and maintained by **SatyamPote** |
| 144 | +For questions or suggestions: [Open an Issue](https://github.com/SatyamPote/CodeStacks/issues) |
| 145 | + |
| 146 | +--- |
| 147 | + |
| 148 | +**Happy Reading! 📖✨** |
0 commit comments