GithubHelp home page GithubHelp logo

kattasahan / cms Goto Github PK

View Code? Open in Web Editor NEW

This project forked from code100x/cms

0.0 0.0 0.0 15.8 MB

Home Page: https://cms-qrlx.vercel.app

Shell 0.05% JavaScript 0.62% TypeScript 98.67% CSS 0.63% Dockerfile 0.04%

cms's Introduction

CMS

Table of contents

Prerequisites

Before you begin, ensure you have met the following requirements

  • Node.js and npm installed on your machine.
  • Docker installed (optional, required for Docker setup).
  • Access to a PostgreSQL database (can be local or hosted).

Setup

Using Docker

  1. Clone the repository:
    git clone https://github.com/your-username/cms.git
  2. Navigate to the project directory:
    cd cms
  3. Run the following command to start the application:
    docker-compose up

Without Docker

  1. clone the repository:
    git clone https://github.com/your-username/cms.git
  2. Navigate to the project directory:
    cd cms
  3. (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
    based on this command the connection url will be
    DATABASE_URL=postgresql://myuser:mypassword@localhost:5432/mydatabase?schema=public
    
  4. Create a .env file based on the .env.example file and configure the DATABASE_URL with your postgreSQL connection string.
  5. Install dependencies:
    npm install
  6. Run database migrations:
    npm run prisma:migrate
  7. Seed the database:
    npm run db:seed
  8. Start the development server:
    npm run dev

Usage

  1. Access the aplication in your browser at http://localhost:3000
  2. Login using any provided user credentials

Contributing

We welcome contributions from the community! To contribute to CMS, follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/fooBar).
  3. Make your changes and commit them (git commit -am 'Add some fooBar').

    Make sure to lint and format your code before commiting

    • npm run lint:check to check for lint errors
    • npm run lint:fix to fix lint errors
    • npm run format:check to format the code
    • npm run format:fix to fix the formatting
  4. Push to the branch (git push origin feature/fooBar).
  5. Create a new 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

Issues on mac Silicon

brew install pkg-config cairo pango libpng jpeg giflib librsvg

cms's People

Contributors

abhirajthakur avatar adexh avatar akash1000x avatar akshayk2021 avatar devsargam avatar dhruvilmehta avatar dyaipayan22 avatar gmin2 avatar haddercone avatar hkirat avatar hxdy-1 avatar kethesainikhil avatar krishhh16 avatar maawan avatar mumin-khan avatar mvp5464 avatar neon-20 avatar nimit9 avatar nishantdotcom avatar prasanth7890 avatar rash-hit avatar shreyas0924 avatar shubham1091 avatar siinghd avatar ssk090 avatar tanayvaswani avatar tanmaydhobale avatar vijaysingh2219 avatar vikaspatil0021 avatar vk-red avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.