Skip to content

sh6252/Color_Hunt_Server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Color Hunt Server 🎨

A Node.js backend server for the Color Hunt project that manages color palette data through a RESTful API.

Overview

The Color Hunt Server provides a robust backend solution for managing and retrieving color palettes. It handles database connections and offers various endpoints to query color palettes based on different conditions, making it perfect for design applications and color discovery tools.

Features

  • 🎯 RESTful API for color palette management
  • 🗄️ Database integration for persistent storage
  • 🔍 Advanced palette filtering and search capabilities
  • 📊 Support for various query conditions
  • 🚀 Fast and efficient data retrieval

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Database (MongoDB)

Installation

  1. Clone the repository:
git clone <repository-url>
cd color_hunt/server
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env
  1. Start the server:
npm start

API Endpoints

Get All Palettes

GET /api/palettes

Get Palettes by Condition

GET /api/palettes?condition=<value>

Testing

Run the test suite:

npm test

Run tests with coverage:

npm run test:coverage

Project Structure

server/
   ├── services/
   ├── modules/
   ├── routers/
   ├── tests/
   └── utils/
├── package.json
└── README.md

Contributing

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.


Built with ❤️ for the Color Hunt project

About

Node.js backend application that manages color palette data through a RESTful API. It handles database connections and provides endpoints to retrieve color palettes with various filtering options. The server supports palette queries by different conditions, making it easy to discover and access curated color combinations for design projects.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors