Merge pull request #13 from meemproject/stage

Stage -> Prod

.env.example

@@ -1,29 +1,31 @@
+# Logging is done using the @kengoldfarb/log package: https://github.com/kengoldfarb/log
 NEXT_PUBLIC_LOG_LEVEL=debug
-NEXT_PUBLIC_INFURA_ID=a8b192f8e7f0463894cb4067092c4574
-NEXT_PUBLIC_MEEMVITE_CONTRACT_ADDRESS=0xF503e9A36402F9184211b7DCAf097b5a59923bAF
 
-NEXT_PUBLIC_NETWORK=rinkeby
-NEXT_PUBLIC_MEEM_CONTRACT_ADDRESS=0x87e5882fa0ea7e391b7e31E8b23a8a38F35C84Ac
-NEXT_PUBLIC_AUCTION_CONTRACT_ADDRESS=0x511556FD98A14f8d68eb5c2940C4fB151C768BbE
-NEXT_PUBLIC_AUCTION_CURRENCY_ADDRESS=0xc778417e063141139fce010982780140aa0cd5ab
-NEXT_PUBLIC_MEEM_ID_CONTRACT_ADDRESS=0x6EC3b14B9844544c710EE48481D8A1E8130F0D7D
+# A JSON RPC endpoint
+NEXT_PUBLIC_JSON_RPC_MAINNET=
 
-NEXT_PUBLIC_IGNORE_OWNERSHIP=true
-# NEXT_PUBLIC_API_URL=http://localhost:3005
-# NEXT_PUBLIC_WS_URL=ws://localhost:3005
+##############################################################################
+# Production Endpoints (https://epm.wtf)
+##############################################################################
+# NEXT_PUBLIC_API_URL=https://api.meem.wtf
+# NEXT_PUBLIC_GRAPHQL_API_URL=https://gql.meem.wtf/v1/graphql
+# NEXT_PUBLIC_GRAPHQL_API_WS_URL=wss://gql.meem.wtf/v1/graphql
+##############################################################################
+
+
+##############################################################################
+# Stage Endpoints (https://stage.epm.wtf)
+##############################################################################
+# NEXT_PUBLIC_API_URL=https://stage-api.meem.wtf
+# NEXT_PUBLIC_GRAPHQL_API_URL=https://stage-gql.meem.wtf/v1/graphql
+# NEXT_PUBLIC_GRAPHQL_API_WS_URL=wss://stage-gql.meem.wtf/v1/graphql
+##############################################################################
+
+
+##############################################################################
+# Dev Endpoints (https://dev.epm.wtf)
+##############################################################################
 NEXT_PUBLIC_API_URL=https://dev-api.meem.wtf
-NEXT_PUBLIC_ALCHEMY_API_KEY=
-NEXT_PUBLIC_MATIC_RPC_URL=
-NEXT_PUBLIC_RINKEBY_RPC_URL=
 NEXT_PUBLIC_GRAPHQL_API_URL=https://dev-gql.meem.wtf/v1/graphql
 NEXT_PUBLIC_GRAPHQL_API_WS_URL=wss://dev-gql.meem.wtf/v1/graphql
-NEXT_PUBLIC_IGNORE_CLUB_CLUB_MEMBERSHIP=false
-
-NEXT_PUBLIC_WS_URL=wss://dev-api-ws.meem.wtf
-NEXT_PUBLIC_TEST_MODE=true
-NEXT_PUBLIC_DAO_ADDRESS=0x40c6BeE45d94063c5B05144489cd8A9879899592
-
-# These are for the dev environment
-NEXT_PUBLIC_MEEM_MAKER_PARENT_TOKEN_ID=100198
-NEXT_PUBLIC_MEEM_TWEETS_PARENT_TOKEN_ID=100059
-NEXT_PUBLIC_MEEM_TWEET_PROMPTS_PARENT_TOKEN_ID=100260
+##############################################################################

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Ken Goldfarb, Meem
+
+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,5 +1,56 @@
-Frontend for clubs-web
+![EPM Logo](https://cdn.meem.wtf/epm-380x380.png)
 
-yarn
+# Ethereum Package Manager
 
-yarn local
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/meemproject/epm/tree/master.svg?style=svg&circle-token=bb0d522cfc34eda3129cfa2abbf758cd04590e5f)](https://dl.circleci.com/status-badge/redirect/gh/meemproject/epm/tree/master)
+
+## [https://epm.wtf](https://epm.wtf)
+
+# What is EPM?
+
+EPM lets you deploy and compose smart contracts. It leans heavily into providing functionality for [EIP-2535 Diamond Standard](https://eips.ethereum.org/EIPS/eip-2535) contracts.
+
+For a more detailed intro see [Introducing Ethereum Package Manager (EPM)](https://paragraph.xyz/@ken/ethereum-package-manager).
+
+Also, [check out the docs](https://docs.meem.wtf/meem-protocol/epm/ethereum-package-manager).
+
+# Installation
+
+1. Install node modules: `yarn`
+2. Copy the `.env.example` file to `.env` and fill out required environment variables
+3. Run it: `yarn local`
+4. Navigate to [http://localhost:3001](http://localhost:3001)
+
+# Code style
+
+CI will fail if the code does not lint. You can check this from the CLI with:
+
+`yarn lint`
+
+You can also auto-fix issues with:
+
+`yarn lint:fix`
+
+It's recommended you use [VSCode](https://code.visualstudio.com/) with these extensions for the best IDE support:
+
+[ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+[GraphQL: Language Feature Support](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql)
+
+[Apollo GraphQL](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo)
+
+[Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+# Branches / Deployment
+
+[`dev`](https://github.com/meemproject/epm/tree/dev) is the main development branch. This is also the branch PRs should be submitted against.
+
+Once tested, code will be moved to [`stage`](https://github.com/meemproject/epm/tree/stage) and finally [`master`](https://github.com/meemproject/epm/tree/master).
+
+Each branch corresponds to an environment that will be automatically updated via CI:
+
+dev - [https://dev.epm.wtf](https://dev.epm.wtf)
+
+stage - [https://stage.epm.wtf](https://stage.epm.wtf)
+
+master - [https://epm.wtf](https://epm.wtf)