Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 2.16 KB

README.md

File metadata and controls

103 lines (74 loc) · 2.16 KB

Dev Project Managment Full Stack App

!! Put Screenshot when project is commpleted

Strained eyes? There's DarkMode too :p

🚀 Quick start

Run the site locally

Step 1: Clone The Repo

Fork the repository. then clone the repo locally by doing -

git clone https://github.com/killcodeX/dev-management.git

Step 2: Install Dependencies

cd into the directory

cd frontend

install all the dependencies

npm install

Step 3: Start Development Server

Then start the development Server

npm start

After running the development server the site should be running on https://localhost:3000

📂 What's inside?

A quick look at the folder structure of this project.

.
├── content
│   ├───blog
│   ├───case-studies
│   └───json
├── cypress
├── plugins
└── src
    ├───components
    │   ├───About
    │   ├───Blog
    │   ├───common
    │   ├───Concepts
    │   ├───Contact
    │   ├───CreativeCoding
    │   ├───Home
    │   ├───Layout
    │   │   └───Navbar
    │   ├───Lightbox
    │   ├───Projects
    │   └───Skills
    ├───hooks
    ├───pages
    ├───static
    │   └───images
    ├───styles
    └───templates

Tools Used

  1. React.js (of course)
  2. Bootstrap and raw CSS for styling
  3. Cypress for E2E Testing && Unit Testing

✌️ Contributing

NOTE: if you want to change the blog content or fix any typo you can do that from github's ui without cloning the repo locally

After cloning & setting up the local project you can push the changes to your github fork and make a pull request.

You can also run the tests locally to see if everything works fine with

Running tests

npm run cypress

Pushing the changes

git add .
git commit -m "commit message"
git push YOUR_REPO_URL develop

Made with ❤️ and Reactjs