Skip to content

Latest commit

 

History

History
204 lines (140 loc) · 7.47 KB

README.md

File metadata and controls

204 lines (140 loc) · 7.47 KB
Raw

Welcome to DevBook 👋💻

Live Website for DevBook : Open your Book!


Repository

DevBook is a social development environment for front-end designers and developers. A project editor that supports HTML, CSS, and JavaScript, where you can show off your work, build test cases to learn and debug, and find inspiration .

Join Here

Join us to build a real-time platform which is built drawing inspiration from CodePen like code editor but with advance features and better enhancements. There are already some extra features like parentheses adding, code folding, auto-tag complete, linting features, auto-saving your previous code in local storage in this some of which you'll not find in other similar code editors. We are planning to build our own code editor that will support HTML, CSS/SCSS, JavaScript/TypeScript as of now. But the bigger vision is to implement frameworks, libraries like React, Angular, Vue etc also in future.

Tech Stacks


Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    $ sudo apt install nodejs
$ sudo apt install npm

  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v8.11.3

$ npm --version
6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

If you want to work on this unique project and share it with the world, you can do that here. Go through the contributing guidelines here.

Subsequently, also go through the GitHub documentation on creating a pull request.

Templates to Follow

Note : One should follow these templates while creating a new issue or pull request.

Folder Structure

Folder structure of this project for your reference

├──.github
│
│
├──public
│   ├── _redirects
│   ├── index.html
│
│
├── src
│   ├── components
│   │   ├── Editor
│   │   ├── Navbar
│   │   ├── ...
│   ├── hooks
│   ├── App.css
│   ├── App.jsx
│   ├── index.css
│   ├── index.jsx
│
|
├── code_of_conduct.md
├── contributing.md
├── LICENSE
├── package.json
├── package-lock.json
└── .gitignore
├── README.md

Workflow:

  • Fork the repository

  • Clone your forked repository using terminal or gitbash.

  • Make changes to the cloned repository

  • Add, Commit and Push

  • Then in GitHub, in your cloned repository, find the option to make a pull request ( Don't forget to select DSCKGEC/DevBook as the base repository while creating new pull request as this repo has been forked from the main repo that is in my personal GitHub account ).

NOTE : For more details Click Here!

Installation

$ npm install

Running the project

$ npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.


console.log ( " Start contributing for Codeaon " );

Open Source Programs


KGEC Summer Of Code

Valuable Contributors

Special thanks goes to all of the mentees who made a choice to make an impact. Contributions of any kind are welcome!🚀

Code Of Conduct

You can find our Code of Conduct here.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project Admin

Sudip Maiti

Give this Project a Star

If you liked working on this project, do ⭐ and share this repository.

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉


© 2022 DSC_KGEC

forthebadge forthebadge