Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yann-github/citizens-of-the-world
Citizens of the world 🌍
https://github.com/yann-github/citizens-of-the-world
api bootstrap react react-router sass sqlite strapi typescript vite
Last synced: 8 days ago
JSON representation
Citizens of the world 🌍
- Host: GitHub
- URL: https://github.com/yann-github/citizens-of-the-world
- Owner: Yann-GitHub
- Created: 2023-11-30T17:15:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-15T19:45:46.000Z (about 1 year ago)
- Last Synced: 2024-01-16T11:02:14.957Z (about 1 year ago)
- Topics: api, bootstrap, react, react-router, sass, sqlite, strapi, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 2.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Citizens of the World
Citizens of the World is a full-stack application built using Strapi, a highly customizable, open-source Headless CMS, as the backend, and React coupled with TypeScript, a powerful combination for building user interfaces, for the frontend.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- Node.js (>=18.0.0 <=20.x.x)
- npm (>=6.0.0)
### Installation
1. Clone the repository
```bash
git clone [email protected]:Yann-GitHub/citizens-of-the-world.git
```
2. Install backend dependencies
```bash
cd backend
npm install
```
3. Install frontend dependencies
```bash
cd ../frontend
npm install
```
### Running the application
#### Backend
From the `backend` directory:
1. To start the application with autoReload enabled (the app will automatically reload if you change any of the source files):
```bash
npm run develop
```
2. To start the application with autoReload disabled (useful for a production environment):
```bash
npm run start
```
3. To build the admin panel (this will create a production-ready build of your application):
```bash
npm run build
```
#### Frontend
From the `frontend` directory:
1. To start the application in development mode (the app will automatically reload if you change any of the source files):
```bash
npm run dev
```
2. To build the application for production (this will create a production-ready build of your application):
```bash
npm run build
```