1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-07-18 20:59:44 +02:00
planka/server/README.md
2025-02-12 16:09:46 +05:30

1.7 KiB

Planka server

This repository contains a Sails.js application that can be run without using sails lift. Instead, you can start the server using node app.js or other process managers.

Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/your-repo.git
    cd your-repo
    
  2. Install dependencies:

    npm install
    

Running the Application

You can start the server using:

node app.js

Alternatively, you can use process managers like:

  • npm start
  • forever start app.js
  • pm2 start app.js
  • node debug app.js

Configuration

You can pass command-line arguments and environment variables to customize the server behavior. Example:

NODE_ENV=production node app.js --port=80 --verbose

For more configuration options, refer to the Sails.js documentation.

Deployment

When deploying to a platform like Heroku, ensure that:

  • All dependencies are installed using npm install --production.
  • The correct environment variables are set.
  • The process is managed correctly (e.g., using forever or pm2).

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

Contact

For any issues or contributions, feel free to open an issue or reach out to [your contact information].