Giter VIP home page Giter VIP logo

the-cat-accountant's Introduction

The CAT Accountant ๐Ÿฑ

Logo

This is an expense tracker application made with MERN stack

Client includes all front end content & Server includes all backend component. Please make sure your environment variables are correct & available.

Logo

Libraries that have been used

Client(FrontEnd) Server(BackEnd)
Axios mongoose
moment express
react-icons concurrently
cors dotenv
antd jsonwebtoken
tailwind bcrypt
react-hot-toast morgan
redux nodemon
webvitals validator

To run the app

  1. Clone the repository to local

  2. If you are working in VS code, split the terminal (hopefully you are in the working directory). If you are working with terminal(mac) or cmd(windows), you will have to run the next steps individually in the respective folders. (just work in VS code, life is much simpler ๐Ÿ˜ผ)

  3. Change directory to client and run npm i or npm install (This will install all dependencies marked in the package.json)

  4. Change directory to server and run npm i or npm install (This will install all dependencies marked in the package.json)

  5. In Client, run npm start

  6. In Server, create environment variables in .env

    You should take make sure have three environment variables

    • MONGO_URI (Use connect from MongoDB Atlas to get the URL and don't forget to include password)
    • PORT (use like 8080 or any other)
    • SECRET_KEY (This will be used for signature in JWT)
  7. In Server, run npm run server

  8. Alternatively you can run command npm run dev in server to run client and server concurrently.

  9. Also make sure the proxy in client matches the port for server. (Very important)

  10. Enjoy the App. ๐Ÿ˜ฝ

P.S. Take care of tailwind by reading the docs at their official website

Known Issues

  1. If your proxy is not able to connect to backend server, you should delete the package-lock.json and node_modules in client and run npm i or npm install again. Before doing this, kill all the terminals and reset everything. This issue seems to be because of cache.

Contributions

Please fork and create PR for contribution.

the-cat-accountant's People

Contributors

deka27 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.