Skip to content

SiddharthShyniben/4c-site

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💎 4C (The Cool Community of Content Creators)

Imagine The Cool Community For Content Creators or 4C, as a chill coffee shop (cooler even 💣). An inclusive and helpful environment, where we help content creators reach their goal by sharing experiences.

Gain access to exclusive talks/workshops with popular content creators, and hence, opportunities to collaborate.

We have games too! 🎮

Join our amazing community on discord and twitter.

Discord Community Twitter Account

4C logo

📷 Website overview

This repository concerns the 4C community website. Visit the website to stay up to date with community members' projects, active memebers, and other amazing content!

🎉 Want to contribute?

Whether you are a community member or not, we would love your point of view! Feel free to first check out our code of conduct and also the contribution guidelines for any missing steps.

💻 For Contributors

🔖 Tech Stack

The code base of this repo uses;

For contributing to code, you will need;

  • Node installed on your computer.
  • Basic knowledge of Git

🔖 Contribution steps

Disclaimer: *In order to run this project locally, you might require some additional configurations. If you try to run the project locally and you get something similar to this:

node error

Follow the steps below to resolve the issue

If you don't have nvm manager, you can follow this steps:

  1. Download nvm-setup.exe
  2. Install nvm-setup.exe in your system
  3. In the terminal
    $ nvm install 16.16.0
  4. $ nvm use 16.16.0
  5. $ node -v
  6. Now your node version should be 16.16.0, you can go ahead now :)
  7. Restart your system

You can directly work on this project on Gitpod

Open in Gitpod

Or, to work on it locally,

  1. Fork this repository

  2. Clone the repo

    $ git clone git@github.com:<your github username>/4c-site.git
  3. Navigate to the cloned directory

    $ cd 4c-site
  4. Install dependencies

    $ npm install
  5. Start the project on localhost

    $ npm run dev

In the course of trying to set up the project locally, if you come across an errror that says PWA is not supported, you can try the following steps below to fix it;

For Linux or Mac 👇

  1. Go to 4c-site folder using cd 4c-site

  2. In the terminal,

    $ export NODE_OPTIONS=--openssl-legacy-provider
  3. If you get an error in the above code then use the option below

    $ unset NODE_OPTIONS=""
  4.     $ npm run dev

    For Windows 👇

  5. Go to 4c-site folder using cd 4c-site

  6. In the terminal,

    $ set NODE_OPTIONS=--openssl-legacy-provider
  7. $ npm run dev

Format check

Before PR, please check formatting first. Eslint may show error, just make sure prettier formatting is ok.

    $ npm run format:check
    $ npm run lint:check

If you get this error "Code style issues found in the above file(s). Forgot to run Prettier?" Run this command

Prettier

    $ npm run format .

Lint

    $ npm run lint

Done!

🔖 Adding a project to the project page

Note: The project page is reserved to display projects for community members only. Each member can put up only one project.

To add your project to the project page, head over to the /content directory, and subsequently, the projects.json file. There, you will find objects for each project.

For example,

{
  "name": "Francesco Ciulla",
  "title": "FREE Web3 Resources",
  "screenshot": "https://user-images.githubusercontent.com/18360871/199210192-f5599a23-f0b1-49ff-9c52-2554a72a2c14.png",
  "description": "A list of resources to learn Web3 for FREE",
  "link": "https://github.com/FrancescoXX/free-Web3-resources",
  "twitter": "https://twitter.com/FrancescoCiull4",
  "live_link": "https://www.freeweb3resources.com"
}
  • Create a new object similar to the one above.
  • Follow the example above and create project details like;
    • Your name
    • Project title
    • A screenshot
    • Short description
    • A link to the GitHub repo (If it is open source)
    • Link to your twitter profile
    • Live link of the project.
  • Open a pull request 👍

Notice anything odd and/or missing from this README or on the website itself? Feel free to raise an issue.

Join the amazing 4C community on discord, and follow us on twitter to stay in the loop.

🔑 License

This repository is under the MIT license.

Please leave a star ⭐ All support is highly appreciated.

About

Open-source website for the 4C

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.8%
  • CSS 2.9%
  • Shell 1.3%