opensource-construction / website

os.c website, content and design components
https://opensource.construction
MIT License
2 stars 4 forks source link
nextjs opensource react storybook

opensource.construction

Making open collaboration successful opensource.construction creates a center of gravity for open source projects and open collaboration in the real estate & construction industry. The association operates as a non-profit organisation based in Switzerland.

This repo

  1. Code for website (/app)
  2. Text content (/content)
  3. UI Components (/components)
  4. Assets (/public)

Content editing

All text content is stored in /content, while images are in /public/images.

To edit the core team members

The information about the core members are stored in JSON format under content/team.json.

Each team member should also include a picture inside public/images/team.

To edit the partners

The information about the partners are stored in JSON format under content/partners.json.

Each partner can have a type: community, industry or academia.

Each partner should also include a logo inside public/images/partners.

New event or project

To publish a new event or projectx:

  1. Open content/events or content/projects
  2. Create a new file (plus icon) named
    • events: YYYYMMDD-urlSlug.mdx
    • projects: urlSlug.mdx
  3. Copy the content from
    • events: /content/events/_template.mdx
    • projects: /content/projects/_template.mdx
  4. Edit the relevant fields and content.
  5. Click on Commit changes...
  6. Describe your changes
  7. Select "Create a new branch for this commit and start a pull request"
  8. Accept or adjust the branch name and click Propose changes

This will automatically start deploying a preview version.

Edit event or project

To suggest an edit for an existing event or project:

  1. Open the file under content/events or content/projects
  2. Make your edits
  3. Click on Commit changes...
  4. Describe your changes
  5. Select "Create a new branch for this commit and start a pull request"
  6. Accept or adjust the branch name and click Propose changes

This will automatically start deploying a preview version.

Upload and use images

  1. Upload the image to public/images/
  2. To use it
![Image alt text](/images/file-name.jpg)

Development

This is based on a Next.js project bootstrapped with create-next-app.

Install dependencies

npm install

To run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!