freshcomm - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #golang #rust #java #awesome #kubernetes #vue #awesome-list #security #mcp #ios #openai

freshcomm

(★ 50)

A self-hostable ecommerce application with a focus on developer productivity and ease of customization.

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- - db.js
- - carouselControllers.js
  - orderControllers.js
  - productController.js
  - userController.js
- - carousels.js
  - categories.js
  - products.js
  - users.js
- - authMiddleware.js
  - errorMiddleware.js
- - carouselModel.js
  - categoryModel.js
  - orderModel.js
  - productModel.js
  - userModel.js
- - carouselRoutes.js
  - categoryRoutes.js
  - orderRoutes.js
  - productRoutes.js
  - uploadRoutes.js
  - userRoutes.js
- - email.js
  - generateToken.js
- seeder.js
- server.js
- - about.txt
  - android-chrome-192x192.png
  - android-chrome-512x512.png
  - apple-touch-icon.png
  - favicon-16x16.png
  - favicon-32x32.png
  - favicon.ico
  - index.html
  - manifest.json
  - robots.txt
- - App.js
  - App.test.js
  - bootstrap.min.css
  - index.css
  - index.js
  - reportWebVitals.js
  - setupTests.js
  - store.js
- package-lock.json
- package.json
- README.md
- orderControllers.test.js
- productController.test.js
- userController.test.js
.gitignore
.nvmrc
.prettierrc.json
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
mocharc.json
package-lock.json
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/roopeshsn/freshcomm

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd freshcomm

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm run dev

개발/실행 서버를 켭니다.

npm run server

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run data:import

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run data:destroy

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Freshcomm

An open-source and self-hostable ecommerce application with a focus on developer productivity and ease of customization.

![homepage-freshcomm](https://user-images.githubusercontent.com/70762571/167148307-718dabc9-057d-4296-853a-6da097d800d4.png)

## Project Purpose!

I am a huge enthusiast of open source. Contributing to open source is a fantastic way to learn and grow. Making open source contributions will require you to have been exposed to a few important concepts, practices, and transferable skills:

- Version control
- Working with tickets & issues
- Working with other developers
- Creating pull requests
- Experiencing a code review process
- Setting up a local development environment
- Contributing code to a pre-existing codebase

## General Idea

Freshcomm is an open-source and self-hostable ecommerce application with a focus on developer productivity and ease of customization.

## Current State

As of now, Freshcomm is built using MERN stack. Additionally, [React Bootstrap](https://react-bootstrap.github.io/) along with [Bootswatch Zephyr](https://bootswatch.com/zephyr/) theme is used for styling and [React Redux](https://react-redux.js.org/) is used for state management.

## Getting Started

### Setting up the repository

Fork the repository at - [roopeshsn/freshcomm](https://github.com/roopeshsn/freshcomm) to your GitHub account.

Then clone the forked repository, by typing the following line in your local terminal/powershell. Remember to replace `<your-username>` with your actual GitHub username.

```bash
git clone https://github.com/<your-username>/freshcomm.git
```

Navigate to the cloned repository on your local system

```bash
cd freshcomm
```

Add remotes to the parent repository. This will help you fetch the code from the
parent repo to avoid any merge conflicts later.

```bash
git remote add upstream https://github.com/roopeshsn/freshcomm.git
```

To verify, use the command `git remote -v` to check if you have two remotes - origin and upstream set up.

Finally, fetch the upstream's latest code from the main branch.

```bash
git fetch upstream master
```

### Env Variables

Create a .env file in then root and add the following

```
NODE_ENV = development
PORT = 5000
MONGODB_URI =
JWT_SECRET =
EMAIL_USERNAME =
EMAIL_PASSWORD =
EMAIL_HOST =
EMAIL_PORT =
CLOUDINARY_CLOUD_NAME =
CLOUDINARY_API_KEY = 
CLOUDINARY_API_SECRET = 
```

### Add data in .env file

The backend folder in this repository serves as the codebase for the API server which connects to a MongoDB instance to store and retrieve user, products, orders data.

#### MONGODB_URI

MongoDB version = 5.0.12. You can either spin up a local/Docker instance or can use MongoDB Atlas (Recommended).

Here's the similar URI which can be used to connect with the cluster
`mongodb+srv://admin:<password>@cluster0.p2u97.mongodb.net/freshcomm?retryWrites=true&w=majority`

Replace <password> with the password for the admin user.

#### JWT_SECRET

Add any string like YOUR_NAME_ANY_SIGN (eg. chrismathew7) is used to create a private key which will authenticate.

#### EMAIL_USERNAME, EMAIL_PASSWORD, EMAIL_HOST, EMAIL_PORT

To get this credentials you need a [Mailtrap](https://mailtrap.io) account. Mailtrap is an Email testing tool. We can simulate this for the forget and reset password functions.

Select Nodemailer from integrations. You will get credentials similar to this,

```
var transport = nodemailer.createTransport({
  host: "smtp.mailtrap.io",
  port: 2525,
  auth: {
    user: "99195eec06f5",
    pass: "d26fe4c7d762"
  }
});
```
  
#### CLOUDINARY_CLOUD_NAME, CLOUDINARY_API_KEY, CLOUDINARY_API_SECRET
Product images are hosted in Cloudinary. Create an account in Cloudinary and add appopriate credentials in `.env` file.

### Install Dependencies (frontend & backend)

```
npm install
cd frontend
npm install
```

### Run

```
# Run frontend (:3000) & backend (:5000)
npm run dev

# Run backend only
npm run server
```

Server should be running on `PORT` specified in env file (or `5000` by default)

To test, type `localhost:PORT/` in your browser and following output should appear.

```
{
  message: 'Welcome to Freshcomm Backend',
  version: process.env.VERSION,
  license: 'MIT',
}
```

## Mail Service

[Mailtrap](https://www.example.com) (A Email Sandbox Service) is used as an email inbox to reset passwords.

## Image Service

The Images for product, slide, category are manually hosted in [Cloudinary](https://cloudinary.com/)

## Build & Deploy

The project is deployed on Heroku

```
git push heroku master
```

The above command is used to deploy the project on Heroku

## Seed Database

You can use the following commands to seed the database with some sample users and products as well as destroy all data:

```
# Import data
npm run data:import

# Destroy data
npm run data:destroy
```

## Contributing

Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information regarding how to contribute.

## License

MIT, see [LICENSE](LICENSE)