Skip to content

Latest commit

 

History

History
144 lines (92 loc) · 2.56 KB

README.md

File metadata and controls

144 lines (92 loc) · 2.56 KB
Raw

CMS - 100xDevs

Open source repo for app.100xdevs.com

Running Locally

Note

This project uses pnpm only as a package manager.

  1. Clone the repository:
git clone https://github.com/code100x/cms.git
  1. Navigate to the project directory:
cd cms

Instant Docker Setup

Note

Your Docker Demon should be online

  1. Running Script for Instant setup
# Gives permission to execute a setup file
chmod +x setup.sh

# Runs the setup script file
./setup.sh

Traditional Docker Setup

(Optional) Start a PostgreSQL database using Docker:

docker run -d \
--name cms-db \
-e POSTGRES_USER=myuser \
-e POSTGRES_PASSWORD=mypassword \
-e POSTGRES_DB=mydatabase \
-p 5432:5432 \
postgres

  1. Create a .env file:

    • Copy .env.example and rename it to .env.

  2. Install dependencies:

pnpm install
  1. Run database migrations:
pnpm prisma:migrate
  1. Generate prisma client
pnpm prisma generate
  1. Seed the database:
pnpm db:seed
  1. Start the development server:
pnpm dev

Usage

  1. Access the application in your browser:
http://localhost:3000
  1. Login using any of the following provided user credentials:

Contributing

We welcome contributions from the community! There are many ways to contribute to the CMS. Code is just one possible means of contribution.

To contribute follow these steps:

  1. Fork the repository.

  2. Clone the fork to your local machine:

git clone https://github.com/<your username>/cms.git
cd cms
  1. Create a new branch
git checkout -b feature/fooBar
  1. Make your changes and commit them
git commit -am 'Add some fooBar'
  1. Push to the branch
git push origin feature/fooBar
  1. Go to the repository and make a Pull Request.

For major changes, please open an issue first to discuss what you would like to change.

Read our contribution guidelines for more details.

Contributors