- Clone the repository
- Set up your environment variables
- Run the quickstart
$ git clone https://github.com/withmono/quickstart.git $ cd quickstart
Alternatively, if you use ssh:
$ git clone [email protected]:withmono/quickstart.git $ cd quickstart
$ cp .env.example .env
.env.example to a new file called
.env and fill out the environment variables inside. Add your
MONO_SECRET. Get your Client ID and secrets from
the dashboard: https://app.mono.co/apps
.envfiles are designed for development only. Never run a production application with an environment file that contains secrets.
makecommand in your terminal: https://formulae.brew.sh/formula/make
- Docker installed and running on your machine: https://docs.docker.com/get-docker/
- Your environment variables in a
.envfile as noted above
- If using Windows, a working Linux installation on Windows 10. If you are using Windows and do not already have WSL or Cygwin configured, we recommend running without Docker (it's easier than installing WSl or Cygwin).
There are three
make commands available
up: builds and starts the container
logs: tails logs for running application
stop: stops the container, you can also use the Docker GUI
Each of these should be used with a
language argument, which is
node. If unspecified, the default is
$ make up language=node
If you change the contents of the server files or
.env file, simply run
make up language=node to rebuild and restart the server.
If you experience a Docker connection error when running the command above, try the following:
- Make sure Docker is running
- Try running the command prefixed with
$ make logs
$ make stop
- The language you intend to use is installed on your machine and available at your command line.
This repo should generally work with active LTS versions of each language such as node >= 14
- Your environment variables populated in
- If using Windows, a command line utility capable of running basic Unix shell commands
Scripts are located in the main directory for your convenience.
Run to install the required dependencies.
This will run both the front and node backend simultaneously in a single convenient terminal.
Once started with one of the commands below, the quickstart will be running on http://localhost:8080 for the backend. Enter the additional commands in step 2 to run the frontend on http://localhost:3000.
$ cd ./node $ npm install $ npm start
$ cd ./frontend $ npm install $ npm start
You have successfully finished the Mono Quickstart, congrats! From this point on, we encourage you to alter the Quickstart code in order to experience using the Mono API. You now have a few options for movement:
You can proceed to the Use cases page for a mapping of typical use cases to matching products if you're unsure of which Mono products you want to use.
Updated about 1 month ago