Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

9 Commits

Folders and files

Repository files navigation

Codersquare

A social web application for sharing and discovering learning resources in a Hacker News-style format

License: MIT TypeScript Node.js Express.js SQLite Contributions Welcome


📋 About

Codersquare is a collaborative platform where developers can share articles, tutorials, and other educational content.
The platform is designed in a Hacker News-style format, making it easy to discover and share valuable learning resources.

I’m building this project publicly, and I welcome contributions from the community.
If you’re interested in helping out, feel free to send a pull request or open an issue.


🛠️ Tech Stack

  • Back-end: Express.js with express-async-handler for simplified error handling
  • Database: SQLite with sqlite and sqlite3 npm packages
  • Development Tools: nodemon (auto restarts), ts-node (TypeScript runtime)
  • Front-end: React (coming soon)
  • Language: TypeScript & JavaScript

🚀 Getting Started

To run this project locally, follow these steps:

✅ Prerequisites

  • Node.js: v14 or higher
  • npm: v6 or higher # Codersquare

A social web application for sharing and discovering learning resources in a Hacker News-style format

License: MIT TypeScript Node.js Express.js SQLite Contributions Welcome


📋 About

Codersquare is a collaborative platform where developers can share articles, tutorials, and other educational content.
The platform is designed in a Hacker News-style format, making it easy to discover and share valuable learning resources.

I’m building this project publicly, and I welcome contributions from the community.
If you’re interested in helping out, feel free to send a pull request or open an issue.


🛠️ Tech Stack

  • Back-end: Express.js with express-async-handler for simplified error handling
  • Database: SQLite with sqlite and sqlite3 npm packages
  • Development Tools: nodemon (auto restarts), ts-node (TypeScript runtime)
  • Front-end: React (coming soon)
  • Language: TypeScript & JavaScript

🚀 Getting Started

To run this project locally, follow these steps:

✅ Prerequisites

  • Node.js: v14 or higher
  • npm: v6 or higher

⚡ Installation

  1. Clone the repository
    git clone https://github.com/MONOCODE-V/codersquare
    cd codersquare

cd server npm install



✨ Key Features

  • 🔐 Authentication: Sign up, log in/out securely, manage profile & settings
  • 💰 Monetization & Community Platform (MCP): Reward system, points-based engagement, future monetization models
  • 📖 Content Sharing: Post, discuss, and discover learning resources in a Hacker News-style feed

🏗️ Architecture

Codersquare is designed with a microservices architecture for scalability and maintainability:

  • Service Discovery: Dynamic service communication
  • API Gateway: Single entry point for routing requests
  • Event-Driven Communication: Async messaging between services

📡 Example API Endpoints

You can test the backend API once the server is running locally:

  • Get all posts
    GET /posts
    
    
    ---
    

📚 Documentation

For detailed design & requirements, see the docs directory:

  • Wireframes: Visual layouts & flows
  • PRD: Product requirements document
  • ERD: Database schema & relationships

🤝 Contributing

Contributions make the open-source community amazing ✨

  1. Fork the project
  2. Create a feature branch
    git checkout -b feature/AmazingFeature
    

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages