README.md

Pluto

A lightweight eCommerce application (not the dwarf planet).

Table of Contents

• Key Features
• Development
• Contributors
• License

Key Features

• Monolithic repo containing store, backend & admin all together.

├── admin
├── backend
└── store

• store follows the MVC architecture.
• store and admin are built using Ant Design for consistent UI design.
• backend is written in TypeScript for predictable static types.

Show screenshots

Screenshots will be added prior to first release

Development

Prerequisites:

• Node.js v12.0+
• Yarn v1.22.0+

Install & development:

⚠️ Using yarn instead of npm is advised.

# Clone repository
git clone https://github.com/Alamin02/pluto.git

# Change directory
cd pluto

# Install dependencies
yarn

Create a .env.local file similar to .env.example. Get cloudinary related config from cloudinary console.

# Start the backend server
yarn start:backend

# Start the store(client end) server
yarn start:store

# Start the admin server
yarn start:admin

Run the following command to generate credentials for admin panel login. Replace [email protected] and test_password with your preferred email and password.

# Create admin account
yarn create:admin [email protected] --password=test_password

Contributors

Organized alphabetically

Farhan Bin Amin

Md. Al Amin

Mehedi Hasan

Raihan Kabir Rifat

Wali Ullah

License

GPL-3.0 License