Skip to content

creativecommons/search

Repository files navigation

search

Creative Commons Search Portal

Code of Conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to conduct@creativecommons.org per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Development

Setting up the Project

For information on learning and installing the prerequisite technologies for this project, please see Foundational technologies — Creative Commons Open Source.

Docker Compose Setup

Use the following instructions to start the Project with docker compose.

  1. Navigate to the creativecommon/search Project that you have cloned

  2. Run the containers

    docker compose up
  3. After running the Above command, Docker will use the docker-compose.yml file and Build a local enivronment for you

  4. Navigate to http://localhost:8080 in your browser and the app would be running.

  5. stop the containers

    To stop the app from running, simply open an another instance of terminal and type

    docker compose down

    or

    You can simply revisit the existing terminal which is running the container and type CTRL + C

Format with Prettier

Run the following command to format files with Prettier:

docker compose exec node prettier --write src/

License

Code

LICENSE: the code within this repository is licensed under the Expat/MIT license.

Content/Text

CC BY 4.0 license button

The content/text within the project is licensed under a Creative Commons Attribution 4.0 International License.