wip

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing Guide
+
+Thank you for considering contributing to Build Gateway! Here are some guidelines to help you get started.
+
+## Getting Started
+
+To contribute to Build Gateway, follow these steps:
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository to your local machine.
+3. Make your changes locally, see the [examples](./examples/) for how to do this.
+4. Test your changes to ensure they work as expected.
+5. Commit your changes with descriptive commit messages. We like [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716).
+6. Push your changes to your fork on GitHub.
+7. Create a pull request to the main repository.
+
+## Code Style
+
+Please follow the existing code style and conventions used in the project.
+
+## Testing
+
+This repository uses playwright tests, which can be found in [/playwright-tests](./playwright-tests/). Ensure that your changes include appropriate tests and that existing tests pass.
+
+## Submitting Issues
+
+If you encounter any issues or have feature requests, please submit them through GitHub issues. Include as much detail as possible to help us understand and address the problem efficiently.
+
+Thank you for your interest in contributing to Build Gateway! Your contributions are greatly appreciated.

README.md

@@ -1,15 +1,15 @@
-# Build DAO Gateway
+# Build Gateway
 
 Let's connect, collaborate, and create solutions together!
 
-This repository holds the front-end widgets for [Build DAO Gateway](https://nearbuilders.org/). This project is configured as a [bos-workspace](https://github.com/nearbuilders/bos-workspace).
+This repository holds the front-end widgets for [Build DAO Gateway](https://nearbuilders.org/). It is configured as a [bos-workspace](https://github.com/nearbuilders/bos-workspace).
 
 ## Setup & Development
 
-1. Initialize submodules and install packages:
+1. Install packages
 
 ```cmd
-yarn run init
+yarn install
 ```
 
 2. Start development version in mainnet:
@@ -24,7 +24,7 @@ Or start the development version in testnet:
 yarn dev:testnet
 ```
 
-This will start a gateway at http://127.0.0.1:8080 which will render your local widgets. The entry point for this app is [buildhub.near/widget/app](http://127.0.0.1:8080/buildhub.near/widget/app).
+This will start a gateway at http://127.0.0.1:8080 which will render your local widgets. The entry point for this app is [buildao.near/widget/Index](http://127.0.0.1:8080/buildao.near/widget/Index).
 
 ### Community Page