Skip to content

Sadaf2005/CodeFolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sure! Below is the content converted into a .md file format:

# Codefolio

Real-time Code Editor for HTML, CSS, and JavaScript

Codefolio is an interactive, user-friendly platform designed for developers and coding enthusiasts. It allows users to sign in and write HTML, CSS, and JavaScript code in real-time with instant output previews. Users can also explore pre-stored projects for inspiration, create and save their own projects, and revisit them anytime.

The platform includes a powerful search functionality that enables users to find projects by their names, ensuring seamless navigation and discovery. Whether you're practicing your coding skills or building a portfolio of creative projects, Codefolio offers a dynamic space to experiment, learn, and showcase your work.

---

## 🚀 Features
- ✍️ **Real-time code editor**: Write HTML, CSS, and JS with instant output preview.
- 📁 **Save and revisit projects**: Create, save, and load your personal coding projects.
- 🔍 **Project search**: Quickly find projects by their names.
- 📚 **Explore other projects**: Browse through pre-stored projects for inspiration.

---

## 📋 Prerequisites
Before running this project, make sure you have the following installed on your system:

- **Node.js** — Download and install Node.js.
- **Yarn** — Install Yarn globally using:
  ```bash
  npm install --global yarn

📦 Project Setup

Follow the steps below to set up and run the project locally.

1️⃣ Clone the Repository

Run the following command to clone the repository to your local machine:

git clone https://github.com/your-username/your-repository-name.git

🔄 Replace your-username/your-repository-name with your GitHub repository URL.

2️⃣ Navigate to the Project Directory

Move into the project folder using:

cd your-repository-name

3️⃣ Install Dependencies

Install all required dependencies listed in package.json by running:

yarn install

💡 Note: If you encounter errors, try running the following commands:

yarn cache clean
yarn install

4️⃣ Run the Project

To start the project, run the following command:

yarn start

🌐 This will start a local development server. View the project in your browser at:
http://localhost:3000

⚠️ Note: If yarn start is not defined in package.json, you can use the following command instead:

yarn global add http-server
http-server .

This will serve your project at:
http://localhost:8080


📂 Folder Structure

project-root/
├── index.html      // Main HTML file
├── css/            // Contains CSS files
├── js/             // Contains JavaScript files
├── images/         // Contains image assets
├── package.json    // Yarn dependencies and scripts
└── README.md       // Project documentation

📜 Scripts

You can automate common tasks by adding scripts to package.json. Example:

"scripts": {
  "start": "http-server .",
  "build": "echo 'Building project...'",
  "test": "echo 'Running tests...'"
}

Command Description

  • yarn start — Starts the project (http://localhost:8080)
  • yarn build — Builds the project for production (optional)
  • yarn test — Runs the tests (optional)

Note: The scripts section is optional, but it makes it easier to manage build and test commands.


🛠️ Troubleshooting

Here are some common issues and how to resolve them:

Issue Solution
🛑 "Yarn not recognized as a command" Make sure Yarn is installed globally by running: yarn -v
Server not running Ensure you have http-server installed by running: yarn global add http-server
⚠️ Cache issues Run: yarn cache clean and yarn install
Port 8080 already in use Close any apps using port 8080 or change the port in http-server options.

📣 Contributing

We welcome contributions from the community! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature:
    git checkout -b feature/your-feature-name
  3. Commit your changes:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin feature/your-feature-name
  5. Submit a pull request.

📝 License

This project is licensed under the MIT License. You are free to use, modify, and distribute this project. See the LICENSE file for more details.


✨ Contact

If you have any questions or suggestions, feel free to open an issue or contact:
📧 alisadaf434@gmail.com

Releases

No releases published

Packages

No packages published