Skip to content

Commit 9f20928

Browse files
committed
feat(Readme):added a readme and gif file + shielf iconas as well
1 parent f45e996 commit 9f20928

File tree

2 files changed

+125
-20
lines changed

2 files changed

+125
-20
lines changed

README.md

Lines changed: 125 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,141 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
21

3-
## Getting Started
2+
# CodeCompass Website
3+
<p align="center">
4+
<a href="https://github.com/CodeCompasss/code_compass_website/actions">
5+
<img src="https://img.shields.io/github/actions/workflow/status/CodeCompasss/code_compass_website/ci.yml?branch=main" alt="Build Status" />
6+
</a>
7+
<a href="LICENSE">
8+
<img src="https://img.shields.io/github/license/CodeCompasss/code_compass_website" alt="License" />
9+
</a>
10+
<a href="https://github.com/CodeCompasss/code_compass_website/issues">
11+
<img src="https://img.shields.io/github/issues/CodeCompasss/code_compass_website" alt="Issues" />
12+
</a>
13+
<a href="https://github.com/CodeCompasss/code_compass_website/pulls">
14+
<img src="https://img.shields.io/github/issues-pr/CodeCompasss/code_compass_website" alt="Pull Requests" />
15+
</a>
16+
<a href="https://github.com/CodeCompasss/code_compass_website/graphs/contributors">
17+
<img src="https://img.shields.io/github/contributors/CodeCompasss/code_compass_website" alt="Contributors" />
18+
</a>
19+
</p>
420

5-
First, run the development server:
21+
<!-- ---
22+
23+
<p align="center">
24+
<img src="./public/assets/demo.gif" alt="CodeCompass Website Demo" width="700"/>
25+
</p>
26+
27+
--- -->
28+
29+
30+
31+
**CodeCompass Website** is the official platform for CodeCompass, an open-source organization building innovative tools for developers and students. The site showcases our projects, team, mission, and provides resources for the community.
32+
33+
- 🌐 Built with Next.js, Tailwind CSS, and TypeScript
34+
- 🎨 Modern, responsive, and accessible UI
35+
- 🛠️ Project explorer for both developer and student tools
36+
- 🌙 Dark mode support
37+
- 🤝 Community-driven and open to contributions
38+
39+
---
40+
41+
## ✨ Features
42+
43+
- **Project Gallery:** Browse all CodeCompass tools, filter by developer/student focus
44+
- **Team & Mission:** Meet the team and learn about our mission
45+
- **Contact & Donate:** Get in touch or support our work
46+
- **Dark/Light Mode:** Seamless theme switching
47+
- **Mobile Ready:** Fully responsive design
48+
49+
---
50+
51+
## 📸 Demo
52+
53+
> ![Demo](./public/assets/code_compass_website.gif)
54+
55+
---
56+
57+
## 🛠️ Tech Stack
58+
59+
- [Next.js](https://nextjs.org/)
60+
- [TypeScript](https://www.typescriptlang.org/)
61+
- [Tailwind CSS](https://tailwindcss.com/)
62+
- [Framer Motion](https://www.framer.com/motion/)
63+
- [Lucide Icons](https://lucide.dev/)
64+
- [TanStack Query](https://tanstack.com/query/latest)
65+
66+
---
67+
68+
## 🚩 Getting Started
69+
70+
### 1. Clone the repository
71+
72+
```bash
73+
git clone https://github.com/CodeCompasss/code_compass_website.git
74+
cd code_compass_website
75+
```
76+
77+
### 2. Install dependencies
78+
79+
```bash
80+
npm install
81+
```
82+
83+
### 3. Run the development server
684

785
```bash
886
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1587
```
1688

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
89+
Visit [http://localhost:3000](http://localhost:3000) to view the site.
90+
91+
---
92+
93+
## 📁 Project Structure
94+
95+
```
96+
code_compass_website/
97+
├── public/
98+
│ ├── assets/
99+
│ └── data/
100+
├── src/
101+
│ ├── app/
102+
│ ├── components/
103+
│ ├── hooks/
104+
│ ├── lib/
105+
│ └── types/
106+
├── tailwind.config.ts
107+
├── postcss.config.mjs
108+
├── package.json
109+
└── ...
110+
```
111+
112+
---
113+
114+
## 🤝 Contributing
115+
116+
We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
18117

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
118+
- Fork the repo
119+
- Create a new branch (`git checkout -b feature/your-feature`)
120+
- Commit your changes
121+
- Open a pull request
20122

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
123+
---
22124

23-
## Learn More
125+
## 📄 License
24126

25-
To learn more about Next.js, take a look at the following resources:
127+
This project is licensed under the [Custom](LICENSE).
26128

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
129+
---
29130

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
131+
## 💬 Contact & Community
31132

32-
## Deploy on Vercel
133+
<!-- - [GitHub Discussions](https://github.com/CodeCompasss/code_compass_website/discussions) -->
134+
<!-- - [Twitter](https://twitter.com/codecompass) -->
135+
- [LinkedIn](https://linkedin.com/company/codecompass)
33136

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
137+
---
35138

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
139+
<div align="center">
140+
**Made with ❤️ by the CodeCompass Team**
141+
</div>
1.17 MB
Loading

0 commit comments

Comments
 (0)