3 |
2 |
3 |
5 | A web based simple double entry system book keeping application.
6 |
7 |
Demo 🚀
8 | ·
9 | Report Bug 😓
10 |
14 | 
15 |
16 | ## About
17 | Lucafy is an open-source, web based, MERN stack, bookkeeping application
18 | that uses double entry accounting. It lets you create journal entries, ledgers
19 | and view trial balance and other statements.
20 |
21 | ## Getting Started
22 | ### Setup
23 | - Clone repository
24 | - Create `.env` file (use the `.envexample` for reference) and add your credentials.
25 | - **Install Dependencies:** Run `npm i` in the main folder for *backend dependencies* and run the same command inside frontend folder for *frontend dependencies*
26 | - Run `npm run dev` in the main folder
27 |
28 | ### Self-Hosted (Server)
29 | 🚧 Work in progress
30 |
31 | ## Demo
32 | 🚧 Work in progress
33 |
34 | ## Contribution
35 | Just send me a pull request. Mention your discord or instagram id.
36 |
37 | (if the instructions were unclear, please let me know)
38 |
39 | ## Contact
40 | Send me a message on discord or instagram. Check out my [Profile Readme](https://github.com/captainAyan)
41 |
--------------------------------------------------------------------------------
/assets/dark_logo_banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/captainAyan/lucafy/a6935f1d04ba046c17ff727812e42260fa68697d/assets/dark_logo_banner.png
--------------------------------------------------------------------------------
/assets/light_logo_banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/captainAyan/lucafy/a6935f1d04ba046c17ff727812e42260fa68697d/assets/light_logo_banner.png
--------------------------------------------------------------------------------
/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/captainAyan/lucafy/a6935f1d04ba046c17ff727812e42260fa68697d/assets/logo.png
--------------------------------------------------------------------------------
/backend/constants/ledgerTypes.js:
--------------------------------------------------------------------------------
1 | exports.INCOME = "income";
2 | exports.EXPENDITURE = "expenditure";
3 | exports.ASSET = "asset";
4 | exports.LIABILITY = "liability";
5 | exports.EQUITY = "equity";
6 |
--------------------------------------------------------------------------------
/backend/constants/policies.js:
--------------------------------------------------------------------------------
1 | exports.LEDGER_LIMIT = 20;
2 | exports.ENTRY_LIMIT = 100;
3 |
4 | exports.PER_MINUTE_REQUEST_LIMIT = 100;
5 | exports.DEFAULT_PAGINATION_LIMIT = 10;
6 |
7 | exports.USER_FIRST_NAME_MAX_LENGTH = 100;
8 | exports.USER_MIDDLE_NAME_MAX_LENGTH = 100;
9 | exports.USER_LAST_NAME_MAX_LENGTH = 100;
10 | exports.USER_EMAIL_MAX_LENGTH = 100;
11 | exports.USER_PASSWORD_MIN_LENGTH = 6;
12 | exports.USER_PASSWORD_MAX_LENGTH = 200;
13 | exports.USER_BIO_MAX_LENGTH = 200;
14 | exports.USER_ORGANIZATION_MAX_LENGTH = 100;
15 | exports.USER_JOB_TITLE_MAX_LENGTH = 100;
16 | exports.USER_LOCATION_MAX_LENGTH = 200;
17 |
18 | exports.LEDGER_NAME_MAX_LENGTH = 50;
19 | exports.LEDGER_DESCRIPTION_MAX_LENGTH = 200;
20 |
21 | exports.ENTRY_NARRATION_MAX_LENGTH = 200;
22 |
--------------------------------------------------------------------------------
/backend/controllers/ledgerController.js:
--------------------------------------------------------------------------------
1 | const { StatusCodes } = require("http-status-codes");
2 | const asyncHandler = require("express-async-handler");
3 |
4 | const Ledger = require("../models/ledgerModel");
5 | const { ErrorResponse } = require("../middlewares/errorMiddleware");
6 | const { createSchema, editSchema } = require("../util/ledgerValidationSchema");
7 | const { LEDGER_LIMIT, PAGINATION_LIMIT } = require("../constants/policies");
8 |
9 | const getLedgers = asyncHandler(async (req, res, next) => {
10 | const PAGE =
11 | parseInt(req.query.page, 10) > 0 ? parseInt(req.query.page, 10) : 0;
12 |
13 | const ledgers = await Ledger.find({ user_id: req.user.id })
14 | .sort("-created_at")
15 | .select(["-user_id", "-balance"])
16 | .skip(PAGE * PAGINATION_LIMIT)
17 | .limit(PAGINATION_LIMIT);
18 |
19 | const response = {
20 | skip: PAGE * PAGINATION_LIMIT,
21 | limit: PAGINATION_LIMIT,
22 | total: await Ledger.find({ user_id: req.user.id }).count(),
23 | ledgers,
24 | };
25 |
26 | res.status(StatusCodes.OK).json(response);
27 | });
28 |
29 | const getAllLedgers = asyncHandler(async (req, res, next) => {
30 | const ledgers = await Ledger.find({ user_id: req.user.id })
31 | .sort("-created_at")
32 | .select(["-user_id", "-balance"]);
33 |
34 | const response = {
35 | ledgers,
36 | };
37 |
38 | res.status(StatusCodes.OK).json(response);
39 | });
40 |
41 | const getLedger = asyncHandler(async (req, res, next) => {
42 | const { id } = req.params;
43 |
44 | let ledger;
45 |
46 | try {
47 | ledger = await Ledger.findOne({ _id: id, user_id: req.user.id }).select([
48 | "-user_id",
49 | "-balance",
50 | ]);
51 | } catch (error) {
52 | // for invalid mongodb objectId
53 | throw new ErrorResponse("Ledger not found", StatusCodes.NOT_FOUND);
54 | }
55 |
56 | if (!ledger) {
57 | throw new ErrorResponse("Ledger not found", StatusCodes.NOT_FOUND);
58 | }
59 |
60 | res.status(StatusCodes.OK).json(ledger);
61 | });
62 |
63 | const createLedger = asyncHandler(async (req, res, next) => {
64 | const { error } = createSchema.validate(req.body);
65 |
66 | if (error) {
67 | throw new ErrorResponse("Invalid input error", StatusCodes.BAD_REQUEST);
68 | }
69 |
70 | const totalLedgers = await Ledger.find({ user_id: req.user.id }).count();
71 |
72 | if (totalLedgers === LEDGER_LIMIT) {
73 | throw new ErrorResponse("Ledger limit reached", StatusCodes.FORBIDDEN);
74 | }
75 |
76 | const l = await Ledger.create({
77 | ...req.body,
78 | user_id: req.user.id,
79 | });
80 |
81 | const ledger = await Ledger.findById(l.id).select(["-user_id", "-balance"]);
82 |
83 | res.status(StatusCodes.CREATED).json(ledger);
84 | });
85 |
86 | const editLedger = asyncHandler(async (req, res, next) => {
87 | const { error } = editSchema.validate(req.body);
88 |
89 | if (error) {
90 | throw new ErrorResponse("Invalid input error", StatusCodes.BAD_REQUEST);
91 | }
92 |
93 | const { id } = req.params;
94 |
95 | let ledger;
96 |
97 | try {
98 | ledger = await Ledger.findOne({ _id: id, user_id: req.user.id }).select([
99 | "-user_id",
100 | "-balance",
101 | ]);
102 | } catch (error) {
103 | // for invalid mongodb objectId
104 | throw new ErrorResponse("Ledger not found", StatusCodes.NOT_FOUND);
105 | }
106 |
107 | if (!ledger) {
108 | throw new ErrorResponse("Ledger not found", StatusCodes.NOT_FOUND);
109 | }
110 |
111 | const { name, type, description } = req.body;
112 |
113 | ledger.name = name;
114 | ledger.type = type;
115 | ledger.description = description;
116 |
117 | ledger.save();
118 |
119 | res.status(StatusCodes.OK).json(ledger);
120 | });
121 |
122 | module.exports = {
123 | createLedger,
124 | getLedgers,
125 | getAllLedgers,
126 | getLedger,
127 | editLedger,
128 | };
129 |
--------------------------------------------------------------------------------
/backend/middlewares/authMiddleware.js:
--------------------------------------------------------------------------------
1 | const jwt = require("jsonwebtoken");
2 | const { StatusCodes } = require("http-status-codes");
3 | const asyncHandler = require("express-async-handler");
4 |
5 | const User = require("../models/userModel");
6 | const { ErrorResponse } = require("./errorMiddleware");
7 |
8 | const protect = asyncHandler(async (req, res, next) => {
9 | if (
10 | req.headers.authorization &&
11 | req.headers.authorization.startsWith("Bearer ")
12 | ) {
13 | try {
14 | const token = req.headers.authorization.split(" ")[1];
15 | const decoded = jwt.verify(token, process.env.SECRET_KEY);
16 |
17 | const user = await User.findById(decoded.id).select("-password");
18 | if (!user) {
19 | throw new ErrorResponse("User does not exist", StatusCodes.BAD_REQUEST);
20 | }
21 |
22 | req.user = user;
23 | next();
24 | } catch (err) {
25 | throw new ErrorResponse("Not authenticated", StatusCodes.UNAUTHORIZED);
26 | }
27 | } else {
28 | throw new ErrorResponse("Not authenticated", StatusCodes.UNAUTHORIZED);
29 | }
30 | });
31 |
32 | module.exports = { protect };
33 |
--------------------------------------------------------------------------------
/backend/middlewares/errorMiddleware.js:
--------------------------------------------------------------------------------
1 | const { StatusCodes } = require("http-status-codes");
2 |
3 | class ErrorResponse extends Error {
4 | constructor(message, status) {
5 | super(message);
6 | this.status = status;
7 | }
8 | }
9 |
10 | const errorHandler = (err, req, res, _) => {
11 | const isProd = process.env.NODE_ENV === "production";
12 |
13 | res.status(err.status || StatusCodes.INTERNAL_SERVER_ERROR).send({
14 | error: {
15 | message: isProd ? "Internal server error" : err.message,
16 | stack: isProd ? null : err.stack,
17 | type: err.type || 0,
18 | code: err.code || 0,
19 | },
20 | });
21 | };
22 |
23 | module.exports = {
24 | ErrorResponse,
25 | errorHandler,
26 | };
27 |
--------------------------------------------------------------------------------
/backend/models/entryModel.js:
--------------------------------------------------------------------------------
1 | const mongoose = require("mongoose");
2 | const { ENTRY_NARRATION_MAX_LENGTH } = require("../constants/policies");
3 |
4 | const entrySchema = new mongoose.Schema(
5 | {
6 | debit_ledger: {
7 | type: mongoose.Schema.Types.ObjectId,
8 | required: true,
9 | ref: "Ledger",
10 | },
11 | credit_ledger: {
12 | type: mongoose.Schema.Types.ObjectId,
13 | required: true,
14 | ref: "Ledger",
15 | },
16 | narration: {
17 | type: String,
18 | required: true,
19 | trim: true,
20 | minlength: 1,
21 | maxlength: ENTRY_NARRATION_MAX_LENGTH,
22 | },
23 | user_id: {
24 | type: mongoose.Schema.Types.ObjectId,
25 | required: true,
26 | ref: "User",
27 | },
28 | amount: {
29 | type: Number,
30 | required: true,
31 | },
32 | },
33 | { timestamps: { createdAt: "created_at", updatedAt: "updated_at" } }
34 | );
35 |
36 | entrySchema.virtual("id").get(function () {
37 | return this._id.toHexString();
38 | });
39 |
40 | entrySchema.set("toJSON", {
41 | virtuals: true,
42 | });
43 |
44 | module.exports = mongoose.model("Entry", entrySchema);
45 |
--------------------------------------------------------------------------------
/backend/models/ledgerModel.js:
--------------------------------------------------------------------------------
1 | const mongoose = require("mongoose");
2 | const {
3 | INCOME,
4 | EXPENDITURE,
5 | ASSET,
6 | LIABILITY,
7 | EQUITY,
8 | } = require("../constants/ledgerTypes");
9 |
10 | const {
11 | LEDGER_NAME_MAX_LENGTH,
12 | LEDGER_DESCRIPTION_MAX_LENGTH,
13 | } = require("../constants/policies");
14 |
15 | const ledgerSchema = new mongoose.Schema(
16 | {
17 | name: {
18 | type: String,
19 | required: true,
20 | trim: true,
21 | minlength: 1,
22 | maxlength: LEDGER_NAME_MAX_LENGTH,
23 | },
24 | type: {
25 | type: String,
26 | required: true,
27 | enum: [INCOME, EXPENDITURE, ASSET, LIABILITY, EQUITY],
28 | },
29 | description: {
30 | type: String,
31 | required: true,
32 | trim: true,
33 | minlength: 1,
34 | maxlength: LEDGER_DESCRIPTION_MAX_LENGTH,
35 | },
36 | balance: {
37 | type: Number,
38 | required: true,
39 | default: 0,
40 | },
41 | user_id: {
42 | type: mongoose.Schema.Types.ObjectId,
43 | required: true,
44 | ref: "User",
45 | },
46 | },
47 | { timestamps: { createdAt: "created_at", updatedAt: "updated_at" } }
48 | );
49 |
50 | ledgerSchema.virtual("id").get(function () {
51 | return this._id;
52 | });
53 |
54 | ledgerSchema.set("toJSON", {
55 | virtuals: true,
56 | });
57 |
58 | module.exports = mongoose.model("Ledger", ledgerSchema);
59 |
--------------------------------------------------------------------------------
/backend/models/userModel.js:
--------------------------------------------------------------------------------
1 | const mongoose = require("mongoose");
2 | const {
3 | USER_FIRST_NAME_MAX_LENGTH,
4 | USER_MIDDLE_NAME_MAX_LENGTH,
5 | USER_LAST_NAME_MAX_LENGTH,
6 | USER_EMAIL_MAX_LENGTH,
7 | USER_PASSWORD_MAX_LENGTH,
8 | USER_PASSWORD_MIN_LENGTH,
9 | USER_LOCATION_MAX_LENGTH,
10 | USER_JOB_TITLE_MAX_LENGTH,
11 | USER_ORGANIZATION_MAX_LENGTH,
12 | USER_BIO_MAX_LENGTH,
13 | } = require("../constants/policies");
14 |
15 | const userSchema = new mongoose.Schema({
16 | firstName: {
17 | type: String,
18 | required: true,
19 | trim: true,
20 | minlength: 1,
21 | maxlength: USER_FIRST_NAME_MAX_LENGTH,
22 | },
23 | middleName: {
24 | type: String,
25 | default: "",
26 | trim: true,
27 | maxlength: USER_MIDDLE_NAME_MAX_LENGTH,
28 | },
29 | lastName: {
30 | type: String,
31 | required: true,
32 | trim: true,
33 | minlength: 1,
34 | maxlength: USER_LAST_NAME_MAX_LENGTH,
35 | },
36 | email: {
37 | type: String,
38 | required: true,
39 | unique: true,
40 | lowercase: true,
41 | trim: true,
42 | minlength: 1,
43 | maxlength: USER_EMAIL_MAX_LENGTH,
44 | },
45 | password: {
46 | type: String,
47 | required: true,
48 | minlength: USER_PASSWORD_MIN_LENGTH,
49 | maxlength: USER_PASSWORD_MAX_LENGTH,
50 | select: false,
51 | },
52 | bio: {
53 | type: String,
54 | default: "",
55 | trim: true,
56 | maxlength: USER_BIO_MAX_LENGTH,
57 | },
58 | organization: {
59 | type: String,
60 | default: "",
61 | trim: true,
62 | maxlength: USER_ORGANIZATION_MAX_LENGTH,
63 | },
64 | jobTitle: {
65 | type: String,
66 | default: "",
67 | trim: true,
68 | maxlength: USER_JOB_TITLE_MAX_LENGTH,
69 | },
70 | location: {
71 | type: String,
72 | default: "",
73 | trim: true,
74 | maxlength: USER_LOCATION_MAX_LENGTH,
75 | },
76 | });
77 |
78 | module.exports = mongoose.model("User", userSchema);
79 |
--------------------------------------------------------------------------------
/backend/routes/api.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 |
5 | router.use("/v1", require("./v1/index"));
6 |
7 | module.exports = router;
8 |
--------------------------------------------------------------------------------
/backend/routes/v1/authRoutes.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 | const {
5 | login,
6 | register,
7 | changePassword,
8 | } = require("../../controllers/userController");
9 | const { protect } = require("../../middlewares/authMiddleware");
10 |
11 | router.post("/login", login);
12 | router.post("/register", register);
13 | router.put("/changepassword", protect, changePassword);
14 |
15 | module.exports = router;
16 |
--------------------------------------------------------------------------------
/backend/routes/v1/entryRoutes.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 | const {
5 | createEntry,
6 | getEntry,
7 | getEntries,
8 | editEntry,
9 | normalizeEntries,
10 | normalizeEntry,
11 | searchEntryByNarration,
12 | } = require("../../controllers/entryController");
13 | const { protect } = require("../../middlewares/authMiddleware");
14 |
15 | router.post("/", protect, createEntry);
16 | router.get("/", protect, getEntries);
17 | router.get("/search", protect, searchEntryByNarration);
18 | router.get("/:id", protect, getEntry);
19 | router.put("/normalize", protect, normalizeEntries);
20 | router.put("/:id", protect, editEntry);
21 | router.put("/normalize/:id", protect, normalizeEntry);
22 |
23 | module.exports = router;
24 |
--------------------------------------------------------------------------------
/backend/routes/v1/index.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 |
5 | router.use("/auth", require("./authRoutes"));
6 | router.use("/profile", require("./profileRoutes"));
7 | router.use("/ledger", require("./ledgerRoutes"));
8 | router.use("/entry", require("./entryRoutes"));
9 | router.use("/statement", require("./statementRoutes"));
10 |
11 | module.exports = router;
12 |
--------------------------------------------------------------------------------
/backend/routes/v1/ledgerRoutes.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 | const {
5 | createLedger,
6 | getLedger,
7 | getLedgers,
8 | getAllLedgers,
9 | editLedger,
10 | } = require("../../controllers/ledgerController");
11 | const { protect } = require("../../middlewares/authMiddleware");
12 |
13 | router.post("/", protect, createLedger);
14 | router.get("/", protect, getLedgers);
15 | router.get("/all", protect, getAllLedgers);
16 | router.get("/:id", protect, getLedger);
17 | router.put("/:id", protect, editLedger);
18 |
19 | module.exports = router;
20 |
--------------------------------------------------------------------------------
/backend/routes/v1/profileRoutes.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 | const {
5 | getProfile,
6 | editProfile,
7 | deleteProfile,
8 | } = require("../../controllers/userController");
9 | const { protect } = require("../../middlewares/authMiddleware");
10 |
11 | router.get("/", protect, getProfile);
12 | router.put("/", protect, editProfile);
13 | router.delete("/", protect, deleteProfile);
14 |
15 | module.exports = router;
16 |
--------------------------------------------------------------------------------
/backend/routes/v1/statementRoutes.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 |
3 | const router = express.Router();
4 | const {
5 | viewLedgerStatement,
6 | viewTrialBalance,
7 | viewMicroStatement,
8 | viewCalendarHeatmap,
9 | exportJournalStatement,
10 | } = require("../../controllers/statementController");
11 | const { protect } = require("../../middlewares/authMiddleware");
12 |
13 | router.get("/ledger/:id", protect, viewLedgerStatement);
14 | router.get("/trial-balance", protect, viewTrialBalance);
15 | router.get("/micro-statement", protect, viewMicroStatement);
16 | router.get("/calendar-heatmap", protect, viewCalendarHeatmap);
17 | router.get("/export", protect, exportJournalStatement);
18 |
19 | module.exports = router;
20 |
--------------------------------------------------------------------------------
/backend/server.js:
--------------------------------------------------------------------------------
1 | const express = require("express");
2 | const mongoose = require("mongoose");
3 | const path = require("path");
4 | const { StatusCodes } = require("http-status-codes");
5 | const morgan = require("morgan");
6 | const rateLimit = require("express-rate-limit");
7 | const helmet = require("helmet");
8 | const cors = require("cors");
9 |
10 | const {
11 | errorHandler,
12 | ErrorResponse,
13 | } = require("./middlewares/errorMiddleware");
14 | const { PER_MINUTE_REQUEST_LIMIT } = require("./constants/policies");
15 |
16 | require("dotenv").config();
17 |
18 | const port = process.env.PORT;
19 | const app = express();
20 | app.use(express.json());
21 | app.use(express.urlencoded({ extended: false }));
22 |
23 | const db = process.env.MONGODB_URI;
24 | mongoose
25 | .connect(db, { useNewUrlParser: true, useUnifiedTopology: true })
26 | .then(() => console.log("MongoDB Connected"))
27 | .catch((err) => console.log(err));
28 |
29 | app.use(morgan("tiny"));
30 |
31 | app.use(helmet());
32 |
33 | app.use(cors());
34 |
35 | const limiter = rateLimit({
36 | windowMs: 10 * 60 * 1000, // 10 minutes
37 | max: process.env.NODE_ENV === "production" ? PER_MINUTE_REQUEST_LIMIT : false,
38 | standardHeaders: true,
39 | legacyHeaders: false,
40 | handler: (req, res, next) => {
41 | throw new ErrorResponse("Too many requests", StatusCodes.TOO_MANY_REQUESTS);
42 | },
43 | });
44 | app.use(limiter); // limits all paths
45 |
46 | app.use("/api", require("./routes/api"));
47 |
48 | // Serve frontend
49 | if (process.env.NODE_ENV === "production") {
50 | app.use(express.static(path.join(__dirname, "../frontend/build")));
51 |
52 | app.get("*", (req, res) =>
53 | res.sendFile(
54 | path.resolve(__dirname, "../", "frontend", "build", "index.html")
55 | )
56 | );
57 | } else {
58 | app.get("/", (req, res) => res.send("Please set to production"));
59 | }
60 |
61 | app.use("*", (req, res, next) => {
62 | throw new ErrorResponse("Not found", StatusCodes.NOT_FOUND);
63 | });
64 |
65 | app.use(errorHandler);
66 |
67 | app.listen(port, () => console.log(`Server started on port ${port}`));
68 |
69 | module.exports = app;
70 |
--------------------------------------------------------------------------------
/backend/util/entryValidationSchema.js:
--------------------------------------------------------------------------------
1 | const Joi = require("joi");
2 | Joi.objectId = require("joi-objectid")(Joi);
3 |
4 | const { ENTRY_NARRATION_MAX_LENGTH } = require("../constants/policies");
5 |
6 | const createSchema = Joi.object({
7 | debit_ledger_id: Joi.objectId().required(),
8 | credit_ledger_id: Joi.objectId().required(),
9 | amount: Joi.number().greater(0).integer().required(),
10 | narration: Joi.string().min(1).max(ENTRY_NARRATION_MAX_LENGTH).required(),
11 | });
12 |
13 | const editSchema = Joi.object({
14 | narration: Joi.string().min(1).max(ENTRY_NARRATION_MAX_LENGTH).required(),
15 | });
16 |
17 | module.exports = { createSchema, editSchema };
18 |
--------------------------------------------------------------------------------
/backend/util/ledgerValidationSchema.js:
--------------------------------------------------------------------------------
1 | const Joi = require("joi");
2 | const {
3 | INCOME,
4 | EXPENDITURE,
5 | ASSET,
6 | LIABILITY,
7 | EQUITY,
8 | } = require("../constants/ledgerTypes");
9 |
10 | const {
11 | LEDGER_NAME_MAX_LENGTH,
12 | LEDGER_DESCRIPTION_MAX_LENGTH,
13 | } = require("../constants/policies");
14 |
15 | const createSchema = Joi.object({
16 | name: Joi.string().min(1).max(LEDGER_NAME_MAX_LENGTH).required(),
17 | type: Joi.string()
18 | .valid(INCOME, EXPENDITURE, ASSET, LIABILITY, EQUITY)
19 | .required(),
20 | description: Joi.string()
21 | .min(1)
22 | .max(LEDGER_DESCRIPTION_MAX_LENGTH)
23 | .required(),
24 | });
25 |
26 | const editSchema = Joi.object({
27 | name: Joi.string().min(1).max(LEDGER_NAME_MAX_LENGTH).required(),
28 | type: Joi.string()
29 | .valid(INCOME, EXPENDITURE, ASSET, LIABILITY, EQUITY)
30 | .required(),
31 | description: Joi.string()
32 | .min(1)
33 | .max(LEDGER_DESCRIPTION_MAX_LENGTH)
34 | .required(),
35 | });
36 |
37 | module.exports = { createSchema, editSchema };
38 |
--------------------------------------------------------------------------------
/backend/util/tokenGenerator.js:
--------------------------------------------------------------------------------
1 | const jwt = require("jsonwebtoken");
2 |
3 | module.exports = (data) =>
4 | jwt.sign(data, process.env.SECRET_KEY, {
5 | expiresIn: "30d",
6 | });
7 |
--------------------------------------------------------------------------------
/backend/util/userValidationSchema.js:
--------------------------------------------------------------------------------
1 | const Joi = require("joi");
2 |
3 | const {
4 | USER_FIRST_NAME_MAX_LENGTH,
5 | USER_LAST_NAME_MAX_LENGTH,
6 | USER_EMAIL_MAX_LENGTH,
7 | USER_PASSWORD_MIN_LENGTH,
8 | USER_PASSWORD_MAX_LENGTH,
9 | USER_MIDDLE_NAME_MAX_LENGTH,
10 | USER_BIO_MAX_LENGTH,
11 | USER_ORGANIZATION_MAX_LENGTH,
12 | USER_JOB_TITLE_MAX_LENGTH,
13 | USER_LOCATION_MAX_LENGTH,
14 | } = require("../constants/policies");
15 |
16 | const createSchema = Joi.object({
17 | firstName: Joi.string().min(1).max(USER_FIRST_NAME_MAX_LENGTH).required(),
18 | lastName: Joi.string().min(1).max(USER_LAST_NAME_MAX_LENGTH).required(),
19 | email: Joi.string().email().min(1).max(USER_EMAIL_MAX_LENGTH).required(),
20 | password: Joi.string()
21 | .min(USER_PASSWORD_MIN_LENGTH)
22 | .max(USER_PASSWORD_MAX_LENGTH)
23 | .required(),
24 | });
25 |
26 | const editSchema = Joi.object({
27 | firstName: Joi.string().min(1).max(USER_FIRST_NAME_MAX_LENGTH).required(),
28 | middleName: Joi.string()
29 | .max(USER_MIDDLE_NAME_MAX_LENGTH)
30 | .allow("")
31 | .optional(),
32 | lastName: Joi.string().min(1).max(USER_LAST_NAME_MAX_LENGTH).required(),
33 | email: Joi.string().email().min(1).max(USER_EMAIL_MAX_LENGTH).required(),
34 | bio: Joi.string().max(USER_BIO_MAX_LENGTH).allow("").optional(),
35 | organization: Joi.string()
36 | .max(USER_ORGANIZATION_MAX_LENGTH)
37 | .allow("")
38 | .optional(),
39 | jobTitle: Joi.string().max(USER_JOB_TITLE_MAX_LENGTH).allow("").optional(),
40 | location: Joi.string().max(USER_LOCATION_MAX_LENGTH).allow("").optional(),
41 | });
42 |
43 | const passwordChangeSchema = Joi.object({
44 | oldPassword: Joi.string().required(),
45 | newPassword: Joi.string()
46 | .min(USER_PASSWORD_MIN_LENGTH)
47 | .max(USER_PASSWORD_MAX_LENGTH)
48 | .required(),
49 | });
50 |
51 | module.exports = { createSchema, editSchema, passwordChangeSchema };
52 |
--------------------------------------------------------------------------------
/build.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | chmod +x ./build.sh
3 |
4 | NPM_CONFIG_PRODUCTION=false
5 |
6 | echo "INSTALL BACKEND DEPENDENCIES"
7 | npm install
8 |
9 | echo "INSTALLING FRONTEND DEPENDENCIES"
10 |
11 | cd frontend
12 | npm install
13 |
14 | echo "INSTALLING FRONTEND DEV DEPENDENCIES"
15 | npm install --only=dev
16 |
17 | echo "BUILDING FRONTEND"
18 |
19 | npm run build
--------------------------------------------------------------------------------
/frontend/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # production
12 | /build
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/frontend/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
11 | 57 | ⚠️ Once deleted, your account can not be recovered. 58 |
59 | 60 |{helperText}
61 | 62 | 70 |({narration})
52 |54 | The maximum number of entries you can create is 100. Once that limit 55 | is reached, you can still utilize this application by{" "} 56 | Normalization of the entries. 57 |
58 |59 | Normalization will get rid of all the individual entries, and store 60 | the current ledger balances into the system. Upon creation of new 61 | entries, the ledger balance will be computed by taking into account 62 | the stored normalized balances and as usual, the entries. 63 |
64 | 65 |66 | Pros : 67 |
74 | Cons : 75 |
89 | Note: It's a good idea to export a report before normalizing 90 | the accounts, so that you don't lose old transaction details. 91 |
92 | 93 |{helperText}
94 | 95 | 103 |({entry.narration})
42 |32 | Download all journal entries in csv format. 33 |
34 | 35 | 43 |29 | Page {page} of{" "} 30 | {Math.ceil(data?.data?.total / data?.data?.limit) || 0} 31 |
32 | 33 |66 | Page {page} of{" "} 67 | {Math.ceil(data?.data?.total / data?.data?.limit) || 0} 68 |
69 | 70 |87 | ({entry?.narration}) 88 |
89 | 90 |106 | {normalizationIsError && 107 | normalizationError?.response?.data?.error?.message} 108 |
109 |17 | 21 | #{id} 22 | 23 | 24 | 25 | 26 |
27 | 28 |({narration})
54 || 15 | ID 16 | | 17 |21 | Time 22 | | 23 |27 | Debit 28 | | 29 |33 | Credit 34 | | 35 |39 | Amount 40 | | 41 | 42 |46 | Narration 47 | | 48 |
|---|
37 |
38 | {/* Header menu */}
39 |
71 | | 20 | ID 21 | | 22 |26 | Ledger 27 | | 28 |32 | Dr. 33 | | 34 |38 | Cr. 39 | | 40 |
|---|---|---|---|
| 47 | | 48 | TOTAL 49 | | 50 |
51 | |
53 |
54 | |
56 |
This is the landing page
8 |9 | 10 | Login 11 | 12 |
13 |
11 | 404
12 |16 | Sorry, we couldn't find the page you're looking for. 17 |
18 |30 | This information will be displayed publicly 31 |
32 |49 | These details help your colleagues look you up 50 |
51 |39 | {isError && error?.response?.data?.error?.message} 40 |
41 |27 | As on date: 28 | 01/02/2025 29 |
30 |