Skip to content

CSCC012023/final-project-s23-calypso

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Calypso

Table of Contents

  1. Overview
  2. Getting Started
  3. Development
  4. Contributing

Overview

Calypso is a platform that allows artists to express their creativity and allows art enthusiasts to explore a diverse range of art. Our platform is designed to accommodate all artforms: digital art, music, animations and much more.

Calypso empowers users to satisfy their art cravings in a simple way. We provide a single platform for every art form. Users no longer have to have multiple accounts for different types of art, Calypso provides access to it all!

Artists can customise their profile to showcase their pieces and attract potential buyers. Our platform also provides the opportunity for commission requests. Further, our unique analytics dashboard allows you to visualise your sales and performance metrics.

Anyone can join our platform to discover a wide variety of art created by unique artists. Calypso makes communication with artists easy, granting the opportunity to discuss commissions or customised pieces that are aligned perfectly with your preferences!

Begin your journey into supporting artists, exploring new artforms and showcasing your masterpieces within our vibrant platform, tailored for any artform!

Getting Started

Installation

Pre-requisites:

  • Node.js version 18.16.0

1. Clone the repository

git clone https://github.com/CSCC012023/final-project-s23-calypso.git

2. Install packages by running the following commands

cd client
npm install 
cd ../server
npm install

3. Run the client

cd client
npm start

4. Run the server

cd server
npm start

If there is a nodemon error, please run the following command:

npm install

Development

  • A MERN (Mongodb, Express, React and Node) tech stack was used to develop this project

  • Software Architecture Pattern: MVC (model view controller)

  • Version Control: Git

  • Jira was used to track product backlog and track and plan our project.

Contributing

To contribute to our project, one can follow the following steps below:

Clone the repository

git clone https://github.com/CSCC012023/final-project-s23-calypso.git

Install packages

npm install 

Create branch

git checkout -b /branchname

Commit changes

git commit -m 'commit message describing what you did'

Push to branch

git push origin /branchname

Open a pull request and await for 2 memebers to code check

About

final-project-s23-calypso created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published