Creative Commons Search Portal
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.
See CONTRIBUTING.md
.
Perform the following steps to create a copy of this repository on your local machine:
Fork the CC Search Portal repository:
Log into GitHub (or create a GitHub account and then log into it).
A copy of this repository is available in your GitHub account.
Get the string to use when cloning your fork:
Click the icon at the right end of that box to copy that URL.
Clone the forked repository from the shell in a local directory with the git clone command, pasting in the URl you saved in the previous step:
git clone https://github.com/<UserName>/search.git
or
git clone git@github.com:<UserName>/search.github.io.git
Where <_UserName_> is your GitHub username. The search.github.io directory is now available in the local directory.
Remember to sync your fork with the main branch regularly.
To Perform the same:-
Go to GitHub and copy the url of the main creativecommons/search repo:
https://github.com/creativecommons/search.git
make sure to be in the root folder of the project and the branch should be main branch and type:
git remote add upstream https://github.com/creativecommons/search.git
Now you have your upstream setup in your local machine, whenever you need to make a new branch for making changes make sure your main branch is in sync with the main repository, to do this, make sure to be in the main branch:
git pull upstream main
git push origin main
Use the following instructions to start the Project with docker compose.
Install Docker (https://docs.docker.com/engine/install/)
Navigate to the creativecommon/search Project that you have cloned
Run the containers
docker compose up
After running the Above command, Docker will use the docker-compose.yml file and Build a local enivronment for you
Navigate to http://localhost:8080 in your browser and the app would be running.
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
Run the following command to format files with Prettier:
docker compose exec node prettier --write src/
LICENSE
: the code within this repository is licensed under the
Expat/MIT license.
The content/text within the project is licensed under a Creative Commons Attribution 4.0 International License.