mansadixit / devfolio

a quick and simple resume generator for developers

devfolio

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing

About The Project

This is a developer resume builder application for software developers to quickly and efficiently generate their CV!

(back to top)

Built With

• React.js

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/randomizemuj/devfolio.git

2. Install NPM packages in the root for the server.js file

   npm install

3. Change the directory to client & install NPM packages

   cd client
   npm install

4. Run the react server in the client folder

   cd client
   npm start

(back to top)

Roadmap

• Making the backend actually work!
• Improvements in UI.
• Making a free developer website.
  • Deployment!

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

(back to top)