Skip to content

Commit

Permalink
Add notice about v3
Browse files Browse the repository at this point in the history
  • Loading branch information
@saadq
saadq committed Jul 30, 2020
1 parent 30f4227 commit 9f52bcc
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
![resumake-logo](https://i.imgur.com/Y4JmhrV.png)

---

# Important Note

All development is currently happening in the Resumake rewrite which is in the [v3](https://github.com/saadq/resumake.io/tree/v3) branch. In the mean time, no further development/fixes will be done in the current app in order to focus efforts on the next version.

---

# resumake.io

> A website for automatically generating elegant LaTeX resumes without the need to write any TeX code yourself.
<a href="https://github.com/saadq/resumake/stargazers">
Expand Down

2 comments on commit 9f52bcc

@henryw4k
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be a noob question, but how do I run v3 locally?
the package.json is inside the /server directory?

Love to help contribute.

@saadq
Copy link
Owner Author

@saadq saadq commented on 9f52bcc Aug 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @henryw4k, both the client and server are independent and have their own package.json files. If you just want to run the web app, you only need to npm install/start the client. This should run the React app, but resume generation won't work unless your server is started as well.

  1. Download the v3 branch from the repo:
git clone -b v3 https://github.com/saadq/resumake.io.git
  1. Run the webapp by going into the app/client directory and running:
npm install
npm start
  1. For resume generation to work, you also need to open another tab in your terminal, go into the app/server directory and run:
npm install
npm start

Note: For resume generation to work, you also need to have LaTeX installed on your system. Check out this link: https://www.latex-project.org/get/

If you still have issues, feel free to join the Discord and chat there about the problem.

Please sign in to comment.