Web3 learning platform
- Node.js 14 and yarn
- Firebase Authentication and Firestore
- Copy the contents in
.env.exampleto.env - Set the Firebase and the Discord variables. You can find discord variables here. Create an application if you don't have one.
- Set all the other necessary variables.
You must have an active google cloud account. Maybe you will have to activate the billing to make it work.
- Install gsutil
- Install gcloud
- run
gcloud config set project <YOUR_FIREBASE_PROJECT>FIREBASE_PROJECT is the name of the project you created on firebase. For example, for me, it isweb3dev-development.
The script bellow will restore a sample database for Firestore, so you can have some data to work with. Run it passing your Google Cloud Bucket as an argument. Reference
- run
./load_db.sh YOUR_GCLOUD_BUCKET
If you want only a local database (it will not interact with many things in the platform), you can simply unzip bkp folder in local and start firebase emulators importing bkp:
firebase emulators:start --import bkp --export-on-exit bkp
Run the following command on your local environment:
git clone https://github.com/w3b3d3v/web3-bootcamp-platform.git web3-bootcamp-plataform
cd web3-bootcamp-plataform
yarn install
Then, you can run locally in development mode with live reload:
yarn run dev
Open http://localhost:3000 with your favorite browser to see your project.
.
├── README.md # README file
├── next.config.js # Next JS configuration
├── public # Public folder
│ └── assets
│ └── img # Image used by default template
├── components # Atomic layout components
├── context # Context
├── firebase # Firebase configuration
├── functions # Cloud functions
├── hooks # Hooks
├── lib # Content library
├── pages # Next JS pages
├── styles # PostCSS style folder with Tailwind
├── scripts # Task-specific scripts
├── .env.example # ENV example file
├── tailwind.config.js # Tailwind CSS configuration
└── tsconfig.json # TypeScript configuration
└── tsconfig.json # TypeScript configuration
You can see the results locally in production mode with:
$ yarn build
$ yarn start
The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.
Now, the plataform is ready to be deployed. All generated files are located at build folder, which you can deploy with any hosting service.
Deploy this project on Vercel in one click:
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug. For more information on how to contribute join our Discord https://pt.discord.w3d.community/
Licensed under the MIT License, Copyright © 2022
See LICENSE for more information.
Made with ♥ by web3dev