Skip to content

nimebox/nimebox-api

Repository files navigation

nimebox-api

GitHub GitHub issues Travis build

✋ Contributing

If you want to help with the project, you can have a look at some issues. All help is much appreciated 🍻

🏃 Running application

What do you need?

🤘 Let's start

  • Clone repo

    • Via https
      git clone https://github.com/nimebox/nimebox-api.git
    • Via ssh
      git clone [email protected]:nimebox/nimebox-api.git
  • Now enter to app dir

    cd nimebox-api
  • Install depedencies

    npm i
    npm i -g vercel # required to run serverless functions
  • Running application

    npm run dev
  • Running application in production mode

    npm run build && npm start
  • Running linter

    npm run lint
  • Running tests

    npm test

📜 License

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