DevsGoWhere

Discover events for engineers in Singapore!

Contributing

To make changes

1. Fork this GitHub repository.
2. Make the changes you need in a new branch.
3. Make a Pull Request to this repo.
4. Once your Pull Request has been merged, you will see the event on the website.

To add an Organisation

Running a script

Run this command in the main folder and follow the prompts:

make create-org

To abort or exit the script, press Ctrl+C.

Note: If you don't have Make installed, you can run the bash script directly bash scripts/create-org.sh.

Manual Steps

1. Create a new folder for your org. Use underscore ("_") instead of spaces (" ").

   mkdir src/content/orgs/<name_of_org>

2. Copy the template into the new folder.

   cp docs/org_template.md src/content/orgs/<name_of_org>/index.md

3. Edit the new markdown file with your content.

4. You can also put the image files in your org folder.

To Add an Event

Running a script

Run this command in the main folder and follow the prompts:

make create-event

To abort or exit the script, press Ctrl+C.

Note: If you don't have Make installed, you can run the bash script directly bash scripts/create-event.sh.

Manual Steps

1. Create a new folder for your org in the events folder. Use underscore ("_") instad of spaces (" ").

   mkdir src/content/events/<name_of_org>

   Important: Use the same folder name as your org.

2. Create a new event folder with the event name. Use underscore ("_") instad of spaces (" ").

   mkdir src/content/events/<name_of_org>/<event_name>

3. Copy the template into the new folder.

   cp docs/event_template.md src/content/events/<name_of_org>/<event_name>/index.md

4. Edit the new markdown file with your event details.

5. You can also put the image files in your event folder.

Developing

To run the app locally

1. Install dependencies

   npm install

2. Start the app:

   npm run dev

   To stop the app, just press Ctrl+C.

3. To test the compilation and build of the website:

   npm run build

Using a Devcontainer

1. Install VSCode and the Dev Containers extension.
2. Install Docker Desktop or an alternative.
3. Open this repo's folder in VSCode.
4. Open the VSCode Command Palette (ctrl+shift+p or Cmd+shift+p) and type: reopen in container
5. Select and press enter on the command.
6. VSCode should reopen and build the Devcontainer.
7. Once the Devcontainer is ready, you should be able to run all the commands above in VSCode's Terminal window.

Deployment of the Website

This repository is connected to CloudFlare Pages. Any changes made to the main branch will be deployed to the website.