Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.25 KB

README.md

File metadata and controls

108 lines (66 loc) · 3.25 KB

Landing Page - idealo.github.io

Test Deploy GitHub Page

Idealo Organisation Stars Idealo Organisation

What this project is all about

This is the landing page for the open source initiative of idealo.de and provides an overview of idealo’s open source projects.

Present your project on idealo.github.io

If you want to present your open source project on the landing page, go to /src/data/projects.js, copy one of the existing projects within the file and simply alter the project-specific information. Title and project ID should be identical to the name of your GitHub project.

Release Changes

Any changes should be introduced via pull request. After merging into the main branch, they will be deployed automatically.

In more detail, the deployment workflow will build the project, run all tests and export the static content to the deployment branch gh-pages.

Run Locally

Clone the project

  git clone https://github.com/idealo/idealo.github.io

Go to the project directory

  cd idealo.github.io

Install dependencies

  npm install

Start the server

  npm run dev

or run directly with the npx CLI:

  npx next dev -p 4000

Docker Version

The Dockerfile you can use, if you want to move this project to a non static version.

Testing

There are Snaphot Tests available, run those tests using npm run test. Please remember to alter these tests if you’ve modified the structure of the page.

FAQ

Can I add Questions here?

Yes for sure, just edit this readme.md and create a pull request!

Feedback

If you have any feedback, please create a github issue.
We will respond as fast as possible to your request.

Roadmap

  • Add a Login
  • Enable automated Process for Releasing OpenSource Projects

License

Apache-2.0

Contributing

Send PULL-Requests if you want to contribute your ideas and alterations to the project. Please remember to stick to the common code conventions and make sure that your commit messages are self-explanatory.

See contributing.md for ways to get started.

Please use the git-hooks to avoid that you commit unlinted/unformated code.

Authors

Thanks

We use/used these Project to make our work easier.
We are happy for OpenSource and want to express our thanks to these Projects:

NextJS