theikkila/erxes-api repository overview

⁠erxes Inc - erxes API

erxes is an open source growth marketing platform. Marketing, sales, and customer service platform designed to help your business attract more engaged customers. Replace Hubspot with the mission and community-driven ecosystem.

View demo⁠ | Download ZIP ⁠ | Join us on Slack⁠ | Join us on Spectrum⁠

⁠Status

⁠Running the server

⁠1. Node (version >= 4) and NPM need to be installed.

Make sure your MongoDB and Redis server is running.

⁠2. Clone and install dependencies.

git clone https://github.com/erxes/erxes-api.git
cd erxes-api
yarn install

⁠3. Create configuration from sample file. We use dotenv⁠ for this.

cp .env.sample .env

.env file description

NODE_ENV=development                        (Node environment: development | production)
PORT=3300                                   (Server port)

MONGO_URL=mongodb://localhost/erxes         (MongoDB url)
TEST_MONGO_URL=mongodb://localhost/test

REDIS_HOST=localhost                        (Redis server url)
REDIS_PORT=6379                             (Redis server port)

MAIN_APP_DOMAIN=http://localhost:3000       (erxes project url)
DOMAIN='http://localhost:3300'              (erxes-api project url)

⁠4. Start the server.

For development:

yarn dev

For production:

yarn build
yarn start

⁠5. Running servers

• GraphQL server: http://localhost:3300/graphql⁠
• Websocket subscriptions server: ws://localhost:3300/subscriptions⁠

⁠Contributors

This project exists thanks to all the people who contribute. [Contribute]⁠.

⁠Backers

Thank you to all our backers! 🙏 [Become a backer⁠]

⁠Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor⁠]

⁠In-kind sponsors

     ⁠      ⁠      ⁠      ⁠

⁠Copyright & License

Copyright (c) 2018 erxes Inc - Released under the MIT license.⁠