Skip to content

Latest commit

 

History

History

meeting-notes

README.md

Meeting Notes Example

Tutorial article: https://dev.to/encore/setting-up-a-free-production-ready-web-app-backend-in-go-with-database-in-less-than-100-lines-4ge4

This is an example application (frontend + backend) for a Markdown Meeting Notes app.

Live demo: https://encoredev.github.io/meeting-notes/

Frontend

The backend uses an SQL database to store meeting notes and has three API endpoints:

  • GET /note/:id - Retrieve a note by ID.
  • POST /note - Create a new note (or update an existing one).
  • GET /images/:query - Search for images by using the Pexels API.

Developing locally

When you have installed Encore, you can create a new Encore application and clone this example by running this command:

encore app create my-app --example=meeting-notes

Running

To run the application locally, make sure you have Docker installed and running. This is required to run Encore applications with SQL databases.

# Run the backend
encore run

# In a different terminal window, run the frontend
cd frontend
npm install
npm run dev

Encore developer dashboard

While encore run is running, open http://localhost:9400/ to view Encore's local developer dashboard. Here you can see the request you just made and a view a trace of the response.

Deployment

Backend

Deploy your backend to a staging environment in Encore's free development cloud.

git push encore

You can view your backend deploys, metrics and traces at https://app.encore.dev.

Frontend

Using GitHub pages

  1. Create a repo on GitHub
  2. In the vite.config.js file, set the base property to the name of your repo:
base: "/example-meeting-notes/",
  1. Push your code to GitHub and wait for the GitHub actions workflow to finish.
  2. Go to Settings → Pages for your repo on GitHub and set Branch to gh-pages.

Your site should now be available at https://<your-github-username>.github.io/<your-repo-name>/.

Pushing new code to GitHub will automatically update your site (see the GitHub actions workflow in the .github folder).

Read more about GitHub pages here.