ksreyr/cityhoy

Cityhoy (English)

Welcome to Cityhoy, our digital meeting point for all citizens who want to stay updated on what's happening in their city. Imagine Twitter and your local newspaper having a baby, that's Cityhoy! A 24-hour news network.

Table of Contents

1. Technologies
2. Installation
3. Usage
4. Contributing
5. License

Technologies

Cityhoy is built with the following technologies:

• Next.js for a super fast user experience.
• Material UI to make everything look good and nice.
• Prisma to keep everything well organized in the back-end.
• TypeScript because we love type safety.
• Docker for deploying all services.
• Cloudfare for requests and Nginx as a reverse proxy and SSL encryption at both ends.

Installation

1. Clone this repository

bashCopy code

git clone https://github.com/your_username_/cityhoy.git

2. Install NPM dependencies

bashCopy code

npm install

3. Configure the environment variables in a .env file based on the .env.template file.

4. Build and start Docker containers

bashCopy code

docker-compose up -d

Usage

Start the development server

bashCopy code

npm run dev

Open http://localhost:3000 in your browser to see the result.

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Cityhoy (Español)

Bienvenidos a Cityhoy, nuestro punto de encuentro digital para todos los ciudadanos que quieren estar al tanto de lo que está pasando en su ciudad. Imagínense a Twitter y a su periódico local teniendo un bebé, ¡eso es Cityhoy! una red de noticias que duran 24 horas.

Tabla de contenidos

1. Tecnologías
2. Instalación
3. Uso
4. Contribuir
5. Licencia

Tecnologías

Cityhoy está construido con las siguientes tecnologías:

• Next.js para una experiencia de usuario súper rápida.
• Material UI para que todo se vea bien y bonito.
• Prisma para mantener todo bien organizado en el back-end.
• TypeScript porque nos encanta la seguridad de los tipos.
• Docker para hacer el deploy de todos los servicios.
• Cloudfare para las peticiones y Nginx como reverse proxy y cifrado SSL en los dos extremos.

Instalación

1. Clona este repositorio

bashCopy code

git clone https://github.com/your_username_/cityhoy.git

2. Instala las dependencias NPM

bashCopy code

npm install

3. Configura las variables de entorno en un archivo .env basado en el archivo .env.template.

4. Construye y arranca los contenedores Docker

bashCopy code

docker-compose up -d

Uso

Inicia el servidor de desarrollo

bashCopy code

npm run dev

Abre http://localhost:3000 en tu navegador para ver el resultado.

Contribuir

Las contribuciones son lo que hacen a la comunidad de código abierto un lugar increíble para aprender, inspirar y crear. Cualquier contribución que quieras hacer será muy apreciada.

1. Haz un Fork del proyecto
2. Crea tu Feature Branch (git checkout -b feature/AmazingFeature)
3. Haz commit de tus cambios (git commit -m 'Add some AmazingFeature')
4. Haz Push a la Branch (git push origin feature/AmazingFeature)
5. Abre un Pull Request

Licencia

Distribuido bajo la licencia MIT. Ver LICENSE para más información.