Code Atlas

A social app to discover and share helpful resources for developers. Find blogs, articles, tools, and other tech-related content. Save favorites, leave comments, and contribute your own discoveries.

💻 General

🗃️ Repository

Clone the repository.

git@github.com:tyronejosee/project_code_atlas.git

🌱 Contribute

If you would like to contribute to the project:

1. Fork the repository.
2. Create a branch with the name of your feature: git checkout -b feature/new-feature.
3. Make your changes and commit: git commit -m 'feat: added new feature'.
4. Push your changes: git push origin feature/new-feature.
5. Open a Pull Request and submit your changes to the develop branch.

⚖️ License

This project is under the Creative Commons Zero v1.0 Universal Licence.

🎨 Frontend

The front-end of the application was created with Next.js using the App Router introduced in Next.js 13 and the package manager PNPM.

✅ Requirements

• Node.js >= 22.11.0
• PNPM >= 9.15.5

⚙️ Installation (Front-end)

To get started, make sure you have PNPM installed on your system. Then, follow these steps:

Install the dependencies:

pnpm install

Available Scripts

Start the development server at http://localhost:3000/

pnpm dev

Build the application for production.

pnpm build

Start the server in production mode.

pnpm start

Run the linter to check the code quality.

pnpm lint

📂 App Router Setup

This project uses the App Router from Next.js to handle routing. Page files (page.tsx) are placed inside folders within the app/ directory. Example:

app/
├── page.tsx         # Main page at "/"
├── urls/
│   └── page.tsx     # URLs page at "/urls"

You can create new routes simply by adding folders inside app/ and adding page.tsx files for the views.

You can deploy this application on platforms like Vercel (the recommended one for Next.js), Netlify, or any other service that supports Node.js.

📦 Resources

Some resources used in this project:

• Pre-commit - Git hooks in Python.
• Next.js Documentation - Frontend framework in JavaScript.
• Prettier - Code formatter in JavaScript.
• Tailwind CSS - CSS framework in JavaScript.
• HeroUI - UI components in JavaScript.
• Lucide - Icons in JavaScript.

Enjoy! 🎉