Feat/prep open source

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct for STAC-Admin Interface
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity, and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism.
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct that could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within and in public spaces when an individual represents the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated, resulting in a response deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality about the reporter of an incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other project leadership members.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing to STAC-Admin Interface
+
+First off, thank you for considering contributing to the STAC-Admin Interface! People like you make the open-source community a great place to learn, inspire, and create.
+
+## How to Contribute
+
+There are many ways you can contribute to our project:
+
+1. **Reporting Bugs**
+   - If you find a bug, please check the issue tracker to see if it has already been reported. If it hasn't, feel free to open a new issue.
+   - When writing your bug report, please include:
+     - A clear and descriptive title.
+     - A detailed description of the issue.
+     - Steps to reproduce the issue.
+     - Any relevant code or screenshots.
+     - Your environment details (OS, browser, etc.).
+
+2. **Suggesting Enhancements**
+   - We welcome suggestions for enhancements! Feel free to use the issue tracker to propose new features or improvements.
+
+3. **Pull Requests**
+   - Fork the repository and create your branch from `main`.
+   - Write clear and meaningful commit messages.
+   - Include comments in your code where necessary.
+   - Update the README.md with details of changes to the interface, if applicable.
+   - Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+   - Open a pull request with a clear title and description.
+
+## Code of Conduct
+Our project adheres to a code of conduct. By participating, you are expected to uphold this code. Please read the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
+
+## Getting Help
+If you need help, feel free to create an issue or contact the project maintainers.
+
+Thank you for contributing to the STAC-Admin Interface!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Development Seed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,59 +1,68 @@
-This project was bootstrapped with
-[Create React App](https://github.com/facebook/create-react-app).
+# STAC-Admin :satellite: :page_facing_up: 
 
-## Available Scripts
+## Introduction
+The STAC-Admin is a tool designed for managing the values of a STAC (SpatioTemporal Asset Catalog) collection and its items. This interface provides a user-friendly way to modify and update the properties of collections and items within a STAC catalog.
 
-In the project directory, you can run:
+## Getting Started
 
-### `yarn start`
+### Prerequisites
+- Node
+- Yarn
 
-Runs the app in the development mode.<br /> Open
-[http://localhost:3000](http://localhost:3000) to view it in the browser.
+### Installation
 
-The page will reload if you make edits.<br /> You will also see any lint errors
-in the console.
+Install Yarn packages:
+   ```
+   yarn install
+   ```
 
-### `yarn test`
+### Configuration
+Before running the application, create a `.env.local` file with the required environment variable:
+- `REACT_APP_STAC_API`: Set this to the API endpoint of your STAC server.
 
-Launches the test runner in the interactive watch mode.<br /> See the section
-about
-[running tests](https://facebook.github.io/create-react-app/docs/running-tests)
-for more information.
+:warning: *The current implementation of `stac-admin` works against the APIs provided by `stac-fastapi`'s **Transaction Extension**. Make sure the extension is enabled and the server accepts `PUT` requests.*
 
-### `yarn build`
+For example, you can use the local deployment of [`eoAPI`](https://github.com/developmentseed/eoAPI) with `docker-compose` to get up and running in minutes:
+```
+cd eoAPI
+docker-compose up
+```
 
-Builds the app for production to the `build` folder.<br /> It correctly bundles
-React in production mode and optimizes the build for the best performance.
+In your `.env.local` file:
+```
+REACT_APP_STAC_API=http://localhost:8081
+```
 
-The build is minified and the filenames include the hashes.<br /> Your app is
-ready to be deployed!
+:bulb: *See `eoAPI` directly for its getting started instruction and getting some sample data ingested.*
 
-See the section about
-[deployment](https://facebook.github.io/create-react-app/docs/deployment) for
-more information.
 
-### `yarn eject`
+### Running the Application
+To start the application in development mode:
+```
+yarn start
+```
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser. The page will reload if you make edits, and lint errors will appear in the console.
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+### Running Tests
+Launch the test runner in interactive watch mode:
+```
+yarn test
+```
+More details can be found in the [Create React App testing documentation](https://facebook.github.io/create-react-app/docs/running-tests).
 
-If you aren’t satisfied with the build tool and configuration choices, you can
-`eject` at any time. This command will remove the single build dependency from
-your project.
+### Building for Production
+Build the app for production:
+```
+yarn build
+```
+This bundles the app in production mode, optimizing the build for performance. The build is minified, and filenames include hashes.
 
-Instead, it will copy all the configuration files and the transitive
-dependencies (webpack, Babel, ESLint, etc) right into your project so you have
-full control over them. All of the commands except `eject` will still work, but
-they will point to the copied scripts so you can tweak them. At this point
-you’re on your own.
+## Contributing
+Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for
-small and middle deployments, and you shouldn’t feel obligated to use this
-feature. However we understand that this tool wouldn’t be useful if you couldn’t
-customize it when you are ready for it.
+## License
+This project is licensed under the MIT license - see the LICENSE.md file for details.
 
 ## Learn More
-
-You can learn more in the
-[Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+- For more information on React, visit the [React documentation](https://reactjs.org/).
+- Check out the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started) to learn more about Create React App.