gsi-kevincarrera / reduced.to Goto Github PK

List of frameworks/libraries used to bootstrap the project.

(back to top)

List of things you need to run the project locally and how to install them.

• npm

  npm install npm@latest -g

• docker

  https://docs.docker.com/get-docker/

1. Fork / Clone this repository
2. Install NPM packages

   npm install

3. Copy .example.env to .env and fill it properly (see Configuration)
4. Make sure you have a local instance of PostgreSQL running on port 5432. If not, you can run it using docker:

   docker run --name reduced_to_db -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=reduced_to_db -p 5432:5432 -d postgres

5. Run Prisma migration from root folder:

   npx nx migrate-dev prisma --name=init

6. Run the backend from root folder:

   npx nx serve backend

7. Run the frontend from root folder:

   npx nx serve frontend

The project is structured in the following way:

.
├── apps/
│   ├── backend
│   └── frontend
└── libs/
    ├── config
    └── prisma

You can build the docker images by running the following nx command:

npx nx run-many -t docker-build

• This command will automatically build the dependencies and the backend and frontend images.

• In case you have docker installed, you can single-click deploy and test your changes by running the following and going to http://localhost:5000/ on your browser.

• When you run the command below, don't forget to change the .env file with the correct values.

  docker compose -f docker/local/docker-compose.yml -p reduced-to up

For the minimal configuration you can just rename the .example.env files to .env.

• BACKEND_APP_PORT: Backend port
• FRONTEND_APP_PORT: Frontend port
• NODE_ENV: Node environment (development / production)

• DATABASE_URL: Database connection string

• RATE_LIMIT_TTL: Rate limit TTL (time to live)
• RATE_LIMIT_COUNT: Number of requests within the ttl

• LOGGER_CONSOLE_THRESHOLD: Threshold level of the console transporter.

• DOMAIN: Domain of your frontend app
• API_DOMAIN: Domain of your backend instance (used for server side requests)
• CLIENTSIDE_API_DOMAIN: Domain of your backend instance (used for client side requests)
• STORAGE_DOMAIN=Domain of your bucket (used for storing images)

• REDIS_ENABLE: Whether to use external Redis store or not
• REDIS_HOST: Redis instance host
• REDIS_PORT: Redis instance port
• REDIS_PASSWORD: Redis instance password
• REDIS_TTL: Redis ttl (in seconds)

• JWT_ACCESS_SECRET: Jwt secret (used for access tokens)
• JWT_REFRESH_SECRET: Jwt secret (used for refresh tokens)

• NOVU_API_KEY: Get it from https://novu.co/, you don't need this when running locally (just verify your email from the database)

Happy Hacking !

(back to top)

Simply copy and paste a URL into the provided area. Then click shorten URL! Your URL has now been shortened!

(back to top)

• Migrate backend to NestJS
• Migrate frontend to Qwik
• Better README
• Generate QRCode
• Split front-end into components
• Better UI
  • Animations
  • Logo
  • Dark/Light mode
• Improve front-end components
• Backend tests
• Migration to Nx
• Split backend into libs
• Support k8s deployment (helm)
• Front-end Tests
• Logs
• Add a statistics page
• Add more ideas

Just create a Pull request already 😃

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

(back to top)

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 ⭐!

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)

This project is licensed under the terms of the MIT License

(back to top)

Project Link: https://github.com/origranot/reduced.to

(back to top)